File size: 122,768 Bytes
3b833d3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | {"id": "freecad-docs:wiki/Add_Workbench_to_Addon_Manager.md", "text": "# Add Workbench to Addon Manager\n## Introduction\n\nThese are step-by-step instructions on how to add a Python workbench to the [Addon Manager](Std_AddonMgr.md).\n\nRequirements:\n\n- A local git repository.\n- A remote git repository. Supported git hosts are [GitHub](https://github.com), [GitLab](https://about.gitlab.com/), [Framagit](https://framagit.org/public/projects) and [Debian Salsa](https://salsa.debian.org/public).\n- Git must be installed.\n\n## Enable developer mode \n\n1. Open the [Preferences Editor](Preferences_Editor.md): select the **Edit → <img src=\"images/Std_DlgPreferences.svg\" width=16px> Preferences...** option from the menu.\n2. Select the **<img src=\"images/Std_AddonMgr.svg\" width=16px> Addon Manager** option in the left bar.\n3. On the **Addon manager options** tab check the **Addon developer mode** checkbox. This will enable the **Developer tools...** button in the Addon Manager.\n4. Press the **OK** button to close the Preferences Editor.\n\n## Create the package.xml file \n\n1. Open the [Addon Manager](Std_AddonMgr.md): select the **Tools → <img src=\"images/Std_AddonMgr.svg\" width=16px> Addon manager** option from the menu.\n2. Press the **Developer tools...** button.\n3. The **Addon Developer Tools** dialog opens.\n <img alt=\"\" src=images/Addon_Manager_Addon_Developer_Tools_Dialog.png style=\"width:350px;\">\n4. Enter the following:\n - \n **Path to Addon**\n \n : The path to the local git repository.\n\n - \n **Addon Name**\n \n : This will appear in the listings of the Addon Manager.\n\n - \n **Description**\n \n : Idem.\n\n - \n **Version**\n \n : Idem.\n\n - \n **Repository URL**\n \n\n - \n **Primary branch**\n \n\n - \n **README URL**\n \n : Recommended.\n\n - \n **Icon**\n \n : The icon must be part of the repository.\n5. Press the **<img src=\"images/List-add.svg\" width=16px>** button at the bottom of the dialog.\n6. The **Content Item** dialog opens.\n <img alt=\"\" src=images/Addon_Manager_Content_Item_Dialog.png style=\"width:350px;\">\n7. The **Content type** should be set to {{Value|Workbench}}.\n8. Check the **This is the only item in the Addon** checkbox.\n9. Enter the **Workbench class name**. This is the class name specified in the **InitGui.py** file.\n10. For the **Subdirectory** enter {{Value|./}}.\n11. Press the **OK** button to close the dialog.\n12. Press the **Save** button to close the **Addon Developer Tools** dialog and save the **package.xml** file.\n13. Press the **<img src=\"images/Process-stop.svg\" width=16px> Close** button to close the Addon Manager.\n14. Push the created file to your remote repository.\n\n## Add the workbench to the .gitmodules file \n\n1. Fork <https://github.com/FreeCAD/FreeCAD-addons>.\n2. Create a new branch.\n3. Edit the **.gitmodules** file to include your new Addon, in alphabetical order.\n4. Push the new branch to GitHub.\n5. Submit a Pull Request to the FreeCAD-Addons repository with the new **.gitmodules** file.\n\n## See also \n\n- [Workbench creation](Workbench_creation.md)\n- [Package Metadata](Package_Metadata.md): Detailed information about the **package.xml** file.\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Add Workbench to Addon Manager\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 875, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_MultiMaterial.md", "text": "---\n GuiCommand:\n Name: Arch MultiMaterial\n MenuLocation: Arch , Material tools , Multi-Material\n Workbenches: Arch_Workbench, BIM_Workbench\n Version: 0.17\n SeeAlso: Arch_SetMaterial\n---\n\n# Arch MultiMaterial\n\n## Description\n\nThe Multi-Material tool defines a list of [materials](Material.md) with, for each material, a name and a thickness value. This multi-materials list can then be added to an [Arch](Arch_Workbench.md) object instead of a single [Arch Material](Arch_SetMaterial.md) .\n\n\n\nNot all Arch objects can currently make use of multi-materials, and the use they do of it differs. Currently:\n\n- <img alt=\"\" src=images/Arch_Wall.svg style=\"width:24px;\"> [Walls](Arch_Wall.md) with a MultiMaterial will use the material definitions and thicknesses to create a multi-layer wall\n- <img alt=\"\" src=images/Arch_Window.svg style=\"width:24px;\"> [Windows](Arch_Window.md) with a MultiMaterial will attribute materials with a given name defined inside the MultiMaterial to window components with a same name or type (see below). Material thickness is not considered.\n- <img alt=\"\" src=images/Arch_Panel.svg style=\"width:24px;\"> [Panels](Arch_Panel.md) with a MultiMaterial will use the material definitions and thicknesses to create a multi-layer panel\n\n## Usage\n\n1. Create first a series of **<img src=\"images/Arch_SetMaterial.svg\" width=16px> [Arch Materials](Arch_SetMaterial.md)** that you will need in your Multi-Material.\n2. Optionally, select an Arch object you wish to attribute the new Multi-Material to.\n3. Press the **<img src=\"images/Arch_MultiMaterial.svg\" width=16px> [Multi-Material](Arch_MultiMaterial.md)** button.\n4. Set the desired material layers.\n\n## Options\n\n\n\nUpon creating or editing a multi-material by double-clicking it in the tree, the following options are available:\n\n- **Duplicate** another existing Multi-Material from the same document. This only copies the values over, and doesn\\'t link the two multi-materials in any way.\n- The **Name** field will also set the material object\\'s Label\n- The **Composition** list is the list of the different material layers that compose this multi-material. Each layer has a name, a material and a thickness value.\n- Click **Add** to add a new layer, **Up** to move a selected layer up, **Down** to move a selected layer down, or **Del** to delete a selected layer.\n- Double-click the **name** of a layer to edit it, the material will offer you a drop-down list of available [Arch Materials](Arch_SetMaterial.md) in the same document, and thickness can be set to any value in any unit\n- Name and Material fields are mandatory. Thickness can be left blank (it will then adopt a value of 0).\n- When a multi-material contains layers with a thickness of zero, that thickness is considered variable. Arch objects that use the multi-material, such as Walls and Panels, will treat that accordingly, and give that layer the remaining space available given their own width or thickness.\n- If you name the different components of a multi-material \\\"Frame\\\", \\\"Solid panel\\\", \\\"Glass panel\\\" or \\\"Louvre\\\", and apply that material to a window, the given materials will be applied to the corresponding window components.\n\n## Relation to IFC \n\nThis roughly corresponds to a combination of [IfcMaterialLayerSet](https://standards.buildingsmart.org/IFC/DEV/IFC4_2/FINAL/HTML/link/ifcmateriallayerset.htm) and [IfcMaterialLayer](https://standards.buildingsmart.org/IFC/DEV/IFC4_2/FINAL/HTML/link/ifcmateriallayer.htm).\n\n## Limitations\n\n## Scripting\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch MultiMaterial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 900, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_Preferences.md", "text": "# Arch Preferences\n1. REDIRECT [BIM_Preferences](BIM_Preferences.md)\n\n\n---\n⏵ [documentation index](../README.md) > Arch Preferences\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 37, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_Remove.md", "text": "---\n GuiCommand:\n Name: Arch Remove\n MenuLocation: Modify , Remove component\n Workbenches: BIM_Workbench\n SeeAlso: Arch_CutPlane, Arch_Add\n---\n\n# Arch Remove\n\n## Description\n\nThe **Arch Remove** tools allows you to do 2 kinds of operations:\n\n- Remove a subcomponent from an Arch object, for example remove a box that has been added to a wall, like in the **<img src=\"images/Arch_Add.svg\" width=16px> [Arch Add](Arch_Add.md)** example.\n- Subtract a [shape](Part_Workbench.md)-based object from an Arch component such as a **<img src=\"images/Arch_Wall.svg\" width=16px> [Arch Wall](Arch_Wall.md)\n** or **<img src=\"images/Arch_Structure.svg\" width=16px> [Arch Structure](Arch_Structure.md)**\n\nThe counterpart of this tool is the **<img src=\"images/Arch_Add.svg\" width=16px> [Arch Add](Arch_Add.md)** tool.\n\n <img alt=\"\" src=images/Arch_Remove_example.jpg style=\"width:600px;\"> \n*A box subtracted from a wall, leaving a hole in it.*\n\n## Usage\n\n1. Select a subcomponent inside an Arch object.\n2. Press the **<img src=\"images/Arch_Remove.svg\" width=16px> [Remove component](Arch_Remove.md)** button, or **Modify → <img src=\"images/Arch_Remove.svg\" width=16px> Remove component** from the top menu.\n\nOr\n\n1. Select objects to be subtracted, the last object selected must the Arch object from which the other objects will be subtracted.\n2. Press the **<img src=\"images/Arch_Remove.svg\" width=16px> [Remove component](Arch_Remove.md)** button, or **Modify → <img src=\"images/Arch_Remove.svg\" width=16px> Remove component** from the top menu.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe Remove tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function:\n\n \n```python\nremoveComponents(objectsList, host=None)\n```\n\n- Removes the given objects in `objectsList` from their parents.\n- If a `host` object is specified, this function will try adding the objects in `objectsList` as holes to the `host`.\n\nExample:\n\n \n```python\nimport FreeCAD, Draft, Arch\n\nLine = Draft.makeWire([FreeCAD.Vector(0, 0, 0),FreeCAD.Vector(2000, 2000, 0)])\nWall = Arch.makeWall(Line, width=150, height=3000)\n\nBox = FreeCAD.ActiveDocument.addObject(\"Part::Box\", \"Box\")\nBox.Length = 900\nBox.Width = 450\nBox.Height = 2000\nFreeCAD.ActiveDocument.recompute()\n\nDraft.rotate(Box, 45)\nDraft.move(Box, FreeCAD.Vector(1000, 700, 0))\n\nArch.removeComponents(Box, Wall)\nFreeCAD.ActiveDocument.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch Remove\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 715, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_SelectNonSolidMeshes.md", "text": "---\n GuiCommand:\n Name: Arch SelectNonSolidMeshes\n MenuLocation: Utils , Select non-manifold meshes\n Workbenches: BIM_Workbench\n SeeAlso: Arch_SplitMesh, Arch_MeshToShape\n---\n\n# Arch SelectNonSolidMeshes\n\n## Description\n\nThe **Arch SelectNonSolidMeshes** tool identifies and selects the non-solid (non-[manifold](http://en.wikipedia.org/wiki/Manifold)) meshes in a selected group of selected <img alt=\"Mesh Workbench\" src=images/Workbench_Mesh.svg style=\"width:24px;\"> [Mesh](Mesh_Workbench.md) objects.\n\n## Usage\n\n1. Select a mesh object.\n2. Select the **Utils → <img src=\"images/Arch_SelectNonSolidMeshes.svg\" width=16px> Select non-manifold meshes** option from the menu.\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch SelectNonSolidMeshes\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 216, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_ToggleSubs.md", "text": "---\n GuiCommand:\n Name: Arch ToggleSubs\n MenuLocation: Utils , Toggle subcomponents\n Workbenches: BIM_Workbench\n Shortcut: Ctrl + Space\n SeeAlso: Arch_Component\n---\n\n# Arch ToggleSubs\n\n## Description\n\nThe **Arch ToggleSubs** tools toggles the visibility of all the subtractions of an [BIM](BIM_Workbench.md) object between visible and hidden.\n\nNormally, if an Arch object, like an [Arch Wall](Arch_Wall.md), is selected and you press **Space** only the external wall will be hidden or made visible, but not the internal objects.\n\nWith this tool, the internal subtracted objects will all become visible or hidden.\n\n## Usage\n\n1. Select an Arch object that has subtractions.\n2. Select the **Utils → <img src=\"images/Arch_ToggleSubs.svg\" width=16px> Toggle subcomponents** option from the menu.\n\n## Options\n\nThe color of a subtraction element can follow the style of [Draft construction](Draft_ToggleConstructionMode.md) elements, by activating the appropriate option in the [Arch Preferences](Arch_Preferences.md), in the menu **Edit → Preferences → Arch → General settings → Apply Draft construction style to subcomponents**.\n\nThe [Draft construction](Draft_ToggleConstructionMode.md) style can be set in the [Draft Preferences](Draft_Preferences.md), in the menu **Preferences → Draft → General Draft**.\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch ToggleSubs\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 334, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_Mesh.md", "text": "# Artwork Mesh\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## src/Mod/Mesh/\n\n### src/Mod/Mesh/Gui/Resources/Icons/\n\n <img alt=\"\" src=images/Mesh_AddFacet.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_BoundingBox.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_BuildRegularSolid.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_CrossSections.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_CursorFillInteractive.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_CurvatureInfo.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Decimating.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Difference.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_EvaluateFacet.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_EvaluateSolid.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Evaluation.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Export.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_FillInteractiveHole.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_FillupHoles.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_FlipNormals.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_FromPartShape.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_HarmonizeNormals.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Import.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Intersection.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Merge.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Pipette.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_PolyCut.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_PolyTrim.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_RemeshGmsh.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_RemoveCompByHand.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_RemoveComponents.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Scale.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_SectionByPlane.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Segmentation.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_SegmentationBestFit.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Smoothing.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_SplitComponents.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Tree.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Tree_Curvature_Plot.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_TrimByPlane.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Union.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_VertexCurvature.svg style=\"width:64px;\"> <img alt=\"\" src=images/Workbench_Mesh.svg style=\"width:64px;\"> \n\n### src/Mod/Mesh/Gui/Resources/Icons/RegularSolids/\n\n <img alt=\"\" src=images/Mesh_Cone.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Cube.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Cylinder.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Ellipsoid.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Sphere.svg style=\"width:64px;\"> <img alt=\"\" src=images/Mesh_Torus.svg style=\"width:64px;\">\n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Mesh](Category_Mesh.md) > Artwork Mesh\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1031, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_Part.md", "text": "# Artwork Part\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## src/Mod/Part/\n\n### src/Mod/Part/Gui/Resources/icons/\n\n <img alt=\"\" src=images/Part_2D_object.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_3D_object.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_BoxSelection.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Detached.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Export.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Feature.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_FeatureImport.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Import.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_SectionCut.svg style=\"width:64px;\"> <img alt=\"\" src=images/PartWorkbench.svg style=\"width:64px;\"> <img alt=\"\" src=images/Preferences-part_design.svg style=\"width:64px;\"> \n\n### src/Mod/Part/Gui/Resources/icons/booleans\n\n <img alt=\"\" src=images/Part_BooleanFragments.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Booleans.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_CheckGeometry.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Common.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Compound.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_CompoundFilter.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_CrossSections.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Cut.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Defeaturing.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_ExplodeCompound.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Fuse.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_JoinBypass.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_JoinConnect.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_JoinCutout.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_JoinEmbed.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Section.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Slice.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_SliceApart.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_XOR.svg style=\"width:64px;\"> \n\n### src/Mod/Part/Gui/Resources/icons/create\n\n <img alt=\"\" src=images/Part_Primitives.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Shapebuilder.svg style=\"width:64px;\"> \n\n### src/Mod/Part/Gui/Resources/icons/parametric\n\n <img alt=\"\" src=images/Part_Box_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Circle_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Cone_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Cylinder_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Ellipse_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Ellipsoid_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Helix_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Line_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Plane_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Point_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Polygon_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Prism_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Sphere_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Spiral_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Spline_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Torus_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Tube_Parametric.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Wedge_Parametric.svg style=\"width:64px;\"> \n\n### src/Mod/Part/Gui/Resources/icons/tools\n\n <img alt=\"\" src=images/Part_Attachment.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Chamfer.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_ColorFace.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Element_Copy.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Extrude.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Fillet.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Loft.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_MakeFace.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_MakeSolid.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Mirror.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Offset.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Offset2D.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_PointsFromMesh.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_ProjectionOnSurface.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Refine_Shape.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Reverse_Shape.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Revolve.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_RuledSurface.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Scale.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Shape_from_Mesh.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_ShapeInfo.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Sweep.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Thickness.svg style=\"width:64px;\"> <img alt=\"\" src=images/Part_Transformed_Copy.svg style=\"width:64px;\">\n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Part](Category_Part.md) > Artwork Part\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1701, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_Reinforcement.md", "text": "# Artwork Reinforcement\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## Mod/Reinforcement/\n\n### Mod/Reinforcement/icons/dropdown_list/\n\n      \n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > Artwork Reinforcement\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 149, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_ReverseEngineering.md", "text": "# Artwork ReverseEngineering\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## src/Mod/ReverseEngineering/\n\n### src/Mod/ReverseEngineering/Gui/Resources/icons/\n\n  \n\n### src/Mod/ReverseEngineering/Gui/Resources/icons/actions/\n\n \n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Reverse Engineering](Category_Reverse%20Engineering.md) > Artwork ReverseEngineering\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 129, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_SheetMetal.md", "text": "# Artwork SheetMetal\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## Mod/SheetMetal/\n\n### Mod/SheetMetal/resources/icons/\n\n <img alt=\"\" src=images/SheetMetal_AddBase.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddBend.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddCornerRelief.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddCutout.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddFoldWall.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddJunction.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddRelief.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_AddWall.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_BaseShape.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_Extrude.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_Forming.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_SketchOnSheet.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_UnattendedUnfold.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_Unfold.svg style=\"width:64px;\"> <img alt=\"\" src=images/SheetMetal_UnfoldUpdate.svg style=\"width:64px;\"> <img alt=\"\" src=images/Sheetmetal_workbench_icon.svg style=\"width:64px;\">\n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [SheetMetal](Category_SheetMetal.md) > Artwork SheetMetal\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 438, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_ConstraintSameOrientation.md", "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintSameOrientation\n Icon: Assembly_ConstraintSameOrientation.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintSameOrientation\n\n## Description\n\nThis tool builds a link between two or more objects of an assembly and matches their orientation. The selected elements of each object or more precisely their implicit coordinate systems (ICS) are used to position one object to another.\n\nAssuming the first object is already locked in place by the <img alt=\"\" src=images/Assembly_ConstraintLock.svg style=\"width:24px;\"> [Lock constraint](Assembly3_ConstraintLock.md) then the following objects are moved to positions where all ICSs have the same orientation i.e. all z-axes are parallel and all x-axes are parallel (making the y-axes parallel as well).\n\nThe offset of their origins in x-, y- and z-direction are not defined. Related to the first object the following objects can still move along the x-, y- and z-axis. This is leaving 3 degrees of freedom (DOFs) for each link unconstrained.\n\nThe constraint accepts planar faces.\n\n## Usage\n\n1. Place two or more objects into an assembly\n2. Select one planar face element of each object\n3. Press the **<img src=\"images/Assembly_ConstraintSameOrientation.svg\" width=16px> [Same orientation](Assembly3_ConstraintSameOrientation.md)** button.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintSameOrientation\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 324, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_CreateElement.md", "text": "---\n GuiCommand:\n Name: Assembly3 CreateElement\n Icon: Assembly_New_Element.svg\n MenuLocation: Assembly3 , Create element\n Workbenches: Assembly3_Workbench\n Shortcut: **A** **E**\n---\n\n# Assembly3 CreateElement\n\n## Description\n\nThe <img alt=\"\" src=images/Assembly_New_Element.svg style=\"width:24px;\"> [Create element](Assembly3_CreateElement.md) command creates new elements from selected objects.\n\nIt can be used to prepare **elements** before the use of constraints. This could come in handy to select e.g. hidden geometry. Once an object is represented by an element, it can easily be accessed by its assembly tree object.\n\n(Usually elements are created from selected objects when a constraint command is applied on them)\n\n## Usage\n\n1. Select one or more objects of the boundary representation such as planar **faces**, straight **edges**, or **points**\n2. There are several ways to invoke the command:\n - Press the **<img src=\"images/Assembly_New_Element.svg\" width=16px> [Create element](Assembly3_CreateElement.md)** button.\n - Select the **Assembly3 → <img src=\"images/Assembly_New_Element.svg\" width=16px> Create element** option from the menu.\n - Use the keyboard shortcut **A** then **E**\n3. (optional but recommended) Rename the elements by editing their **Label** properties.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 CreateElement\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 330, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_ImportFromSTEP.md", "text": "---\n GuiCommand:\n Name: Assembly3 ImportFromSTEP\n Icon: Assembly_Import.svg\n MenuLocation: Assembly3 , Import from STEP , Import from STEP\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ImportFromSTEP\n\n## Description\n\nThe <img alt=\"\" src=images/Assembly_Import.svg style=\"width:24px;\"> [Import from STEP](Assembly3_ImportFromSTEP.md) command opens a file browser window to search and select STEP files.\n\n(STEP assemblies are imported into a single document.)\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Depending on the button condition do one of the following:\n - Press the icon of the **<img src=\"images/Assembly_Import.svg\" width=16px><img src=\"images/Toolbar_flyout_arrow.svg\" width=x16px> [Import from STEP](Assembly3_ImportFromSTEP.md)** button.\n - Press the down arrow of the **<img src=\"images/Assembly_ImportMulti.svg\" width=|x16px><img src=\"images/Toolbar_flyout_arrow.svg\" width=x16px> '''Import as multi-document'''** button and select the **<img src=\"images/Assembly_Import.svg\" width=16px> Import from STEP** option from the dropdown.\n - Select the **Assembly3 → Import from STEP → <img src=\"images/Assembly_Import.svg\" width=16px> Import from STEP** option from the menu.\n - Select the **Assembly → Import from STEP → <img src=\"images/Assembly_Import.svg\" width=16px> Import from STEP** option from the [Tree view](Tree_view.md) context menu or the [3D view](3D_view.md) context menu.\n2. A file browser opens.\n3. Select the STEP file to import\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ImportFromSTEP\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 426, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_QuickSolve.md", "text": "---\n GuiCommand:\n Name: Assembly3 QuickSolve\n Icon: Assembly_QuickSolve.svg\n MenuLocation: Assembly3 , Quick solve\n Workbenches: Assembly3_Workbench\n Shortcut: **A** then **F**\n---\n\n# Assembly3 QuickSolve\n\n## Description\n\nThe <img alt=\"\" src=images/Assembly_QuickSolve.svg style=\"width:24px;\"> [Quick solve](Assembly3_QuickSolve.md) command starts the solver algorithm that relocates all objects of an assembly according to the constraints in the <img alt=\"\" src=images/Assembly_Assembly_Constraints_Tree.svg style=\"width:16px;\"> [Constraints container](Assembly3_CreateAssembly#Description.md).\n\n\n: (Here\\'s the space to put the differences to the <img alt=\"\" src=images/Assembly3_workbench_icon.svg style=\"width:16px;\"> [Resolve constraints](Assembly3_ResolveConstraints.md) command\\...)\n\n\n## Usage\n\n1. Activate the <img alt=\"\" src=images/Assembly_QuickSolve.svg style=\"width:16px;\"> **Quick solve** command using one of the following:\n - The **<img src=\"images/Assembly_QuickSolve.svg\" width=16px> [Quick solve](Assembly3_QuickSolve.md)** button.\n - The **Assembly3 → <img src=\"images/Assembly_QuickSolve.svg\" width=16px> Quick solve** menu option.\n - The keyboard shortcut: **A** then **F**.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 QuickSolve\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 358, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly_CreateJointParallel.md", "text": "---\n GuiCommand:\n Name: Assembly CreateJointParallel\n MenuLocation: Assembly , Create Parallel Joint\n Workbenches: Assembly_Workbench\n Shortcut: **N**\n Version: 1.0\n SeeAlso: \n---\n\n# Assembly CreateJointParallel\n\n## Description\n\nThe <img alt=\"\" src=images/Assembly_CreateJointParallel.svg style=\"width:24px;\"> [Assembly CreateJointParallel](Assembly_CreateJointParallel.md) tool creates a Parallel joint between two selected parts, setting the Z axes of selected coordinate systems parallel.\n\n## Usage\n\n1. There are several ways to invoke the tool:\n - Press the **<img src=\"images/Assembly_CreateJointParallel.svg\" width=16px> [Create Parallel Joint](Assembly_CreateJointParallel.md)** button.\n - Select the **Assembly → <img src=\"images/Assembly_CreateJointParallel.svg\" width=16px> Create Parallel Joint** option from the menu.\n - Use the keyboard shortcut: **N**.\n2. \\...\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nA **Parallel** object is derived from an [App FeaturePython](App_FeaturePython.md) object and inherits all its properties. See [Assembly CreateJointFixed](Assembly_CreateJointFixed#Properties.md) for additional properties.\n\n\n {{Assembly_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Assembly](Assembly_Workbench.md) > Assembly CreateJointParallel\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 311, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Beam.md", "text": "---\n GuiCommand:\n Name: BIM Beam\n MenuLocation: 3D/BIM , Beam\n Workbenches: BIM_Workbench\n Shortcut: **B** **M**\n SeeAlso: \n---\n\n# BIM Beam\n\n## Description\n\nThe **BIM Beam** tool creates a **Beam** object, a horizontal structure element, between two points.\n\n## Usage\n\n1. There are several ways to invoke the tool:\n - Press the **<img src=\"images/BIM_Beam.svg\" width=16px> [Beam](BIM_Beam.md)** button.\n - Select the **3D/BIM → <img src=\"images/BIM_Beam.svg\" width=16px> Beam** option from the menu.\n - Use the keyboard shortcut: **B** then **M**.\n2. \\...\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Beam\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 210, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Clone.md", "text": "---\n GuiCommand:\n Name: BIM Clone\n MenuLocation: Modify , Clone\n Workbenches: BIM_Workbench\n SeeAlso: Draft_Clone\n---\n\n# BIM Clone\n\n## Description\n\nThe **BIM Clone** tool is a shortcut to the standard [Draft Clone](Draft_Clone.md) tool, but launches a [Draft Move](Draft_Move.md) command just after cloning, thus allowing you to clone and place the cloned object somewhere else in the model in one go.\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Clone\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 133, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Common.md", "text": "# BIM Common\n1. REDIRECT [Part_Common](Part_Common.md)\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Common\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 46, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Diff.md", "text": "---\n GuiCommand:\n Name: BIM Diff\n MenuLocation: Utils , IFC Diff\n Workbenches: BIM_Workbench\n---\n\n# BIM Diff\n\n## Description\n\nThe **BIM Diff** tool takes two open FreeCAD documents, and produces a visual diff between them.\n\n\\\"diff\\\" in programming refers to a utility application that takes two text documents and highlights the lines that are different between them. It usually marks in red the lines that have been removed and in green the lines that have been added. Its main purpose is to quickly grasp what has changed in two different versions of the same document.\n\nThis tool does the same thing, but graphically. It opens a new document, shows the contents of file B, but highlights:\n\n <img alt=\"\" src=images/BIM_Diff_example.jpg style=\"width:640px;\"> \n\nThis tool is primarily suited for IFC files, as it uses the IFC Global ID to make sure one object in one file is still the same in the other file. However, it will also work with two non-IFC FreeCAD files.\n\n## Usage\n\n1. Open a document in FreeCAD.\n2. Open a second document in FreeCAD, that you wish to compare with the first one.\n3. Select the **Utils → <img src=\"images/BIM_Diff.svg\" width=16px> IFC Diff** option from the menu.\n\n## Options\n\n- in **red** all elements of file A that are not present anymore in B\n- in **green** all elements that are in B but weren\\'t present in A\n- in **yellow** all elements that were in A and are still in B, but their geometry has changed\n- in **orange** all elements that were in A and are still in B, their geometry is still the same, but other properties has changed\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Diff\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 419, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Basic_Part_Design_Tutorial.md", "text": "---\n TutorialInfo:\n Topic: Modeling\n Level: Beginner\n Author: Mark Stephen and HarryGeier \n Time: Less than an hour\n FCVersion: 0.17 or higher Files: https://github.com/FreeCAD/Examples/blob/master/Basic_Part_Design_Tutorial_Example_017_Files/Basic_Part_Design_Tutorial_017.fcstd Basic Part Design for v0.17\n SeeAlso: Basic_Part_Design_Tutorial_019\n---\n\n# Basic Part Design Tutorial\n\n \n\n\nThis tutorial introduces the new user to some of the tools and techniques used in the [PartDesign Workbench](PartDesign_Workbench.md). This tutorial is not a complete and comprehensive guide to the Part Design Workbench and many of the tools and capabilities are not covered. This tutorial will take user through the steps needed to model the part shown in the image below using sketches.\n\n  \n\nA video of the whole construction is here: <https://youtu.be/geIrH1cOCzc>\n\n(each section has its own split Video below)\n\n## Before You Begin \n\n## The Task \n\nIn this tutorial, you will be using the Part Design Workbench to create a 3D solid model of the part shown in the [Drawing](TechDraw_Workbench.md) below. All of the necessary dimensions to complete this task are given. You will start by creating a core shape from a base Sketch and then build on that shape, adding what is known as Features. These features will either add material to, or remove material from the solid by use of additional sketches and accompanying feature operations. This Tutorial will not use every feature and tool available within the Part Design Workbench, but should use enough to give the user of this tutorial a basic foundation upon which to build their knowledge and skills.\n\n## The Part \n\n  \n\n## Constructing The Part \n\n### Startup\n\nFirst begin by making sure you are in the Part Design Workbench. Once there, you will want to create a new document if you have not done so already. It is a good habit to save your work often, so before anything else save the new document, giving it any name you might like.\n\nAll work in Part Design begins with a [Body](Glossary#Body.md). Then we will build the solid inside the body by starting with a [sketch](Glossary#Sketch.md).\n\n1. Click on <img alt=\"\" src=images/PartDesign_Body.svg style=\"width:24px;\"> [Create new body](PartDesign_Body.md) to create and activate a new Body Container. \n*Note: this step can be omitted. When creating a sketch, if no existing Body is found, a new one will be automatically created and activated.*\n2. Click on <img alt=\"\" src=images/PartDesign_NewSketch.svg style=\"width:24px;\"> [Create new sketch](PartDesign_NewSketch.md). This will create the sketch within the just created body.\n3. We need to define where the sketch will be attached. We will attach it to a plane from the Body´s [Origin](Glossary#Origin.md).\n4. In the [Tasks tab](Task_panel.md) from the [Combo view](Combo_view.md), select **YZ_Plane** in the list and press **OK**:\n\n <img alt=\"\" src=images/Tut17_sketchplanes.png style=\"width:250px;\"> \n\n*Note: it\\'s possible that the **OK** button may not be visible if the side panel is not wide enough. You can make it wider by dragging its right border. Place your mouse pointer over the border; when the pointer changes to a two-way arrow, press and hold the left mouse button and drag.*\n\nOnce you click OK, FreeCAD automatically switches to the [Sketcher workbench](Sketcher_Workbench.md) and opens the sketch in edit mode:\n\n  \n\n### Create the sketch \n\nNext you will want to use the <img alt=\"\" src=images/Sketcher_CreatePolyline.svg style=\"width:24px;\"> [Polyline](Sketcher_CreatePolyline.md) tool and make a shape roughly like that in the next image. It does not need to be perfect as the final shape is done with constraints. Once you have the basic shape, we will start applying the constraints. If you had Auto constraints on, some of these constraints will have been applied automatically, if not, do the following. But first make sure that you have exited the Polyline tool by right-clicking or pressing **ESC** twice; the mouse cursor should turn back from a cross-hair to the standard arrow cursor. Don\\'t press **ESC** a third time or you will exit edit mode; if this happens, click on the Model tab, then double-click the Sketch element in the tree, or right-click and select **Edit sketch** in the context menu. To avoid leaving edit mode when pressing **Esc** too often, change the **Esc can leave sketch edit mode** preference (<small>(v0.19)</small> ), see [Sketcher Preferences](Sketcher_Preferences#General.md).\n\n*NOTE: Since this tutorial was written there have been improvements to the sketcher solver, if it detects a redundant constraint it will turn the sketch orange in colour, and before further constraints are added, the redundant constraint should be removed. (The redundant constraint is shown in the Task view, click on the blue reference and press delete.)*\n\n1. Select the two horizontal lines with your mouse by clicking on them, and once selected, click on the <img alt=\"\" src=images/Sketcher_ConstrainHorizontal.svg style=\"width:24px;\"> [horizontal constraint](Sketcher_ConstrainHorizontal.md).\n2. Select the vertical line on the right and then click on the <img alt=\"\" src=images/Sketcher_ConstrainVertical.svg style=\"width:24px;\"> [vertical constraint](Sketcher_ConstrainVertical.md).\n3. Select the start and end points of your polyline and click on the <img alt=\"\" src=images/Sketcher_ConstrainCoincident.svg style=\"width:24px;\"> [coincident constraint](Sketcher_ConstrainCoincident.md) to close the polyline.\n4. Select the bottom horizontal line and the right vertical line and apply and <img alt=\"\" src=images/Sketcher_ConstrainEqual.svg style=\"width:24px;\"> [equal constraint](Sketcher_ConstrainEqual.md).\n5. Select either the horizontal or vertical line and apply either a corresponding <img alt=\"\" src=images/Sketcher_ConstrainDistanceX.svg style=\"width:24px;\"> [horizontal distance constraint](Sketcher_ConstrainDistanceX.md) or <img alt=\"\" src=images/Sketcher_ConstrainDistanceY.svg style=\"width:24px;\"> [vertical distance constraint](Sketcher_ConstrainDistanceX.md) and give it a value of 26 mm.\n6. Select the top horizontal line and apply the horizontal distance constraint and give it a value of 5 mm\n7. Select the lower right point (vertex) of the horizontal line Origin and then the center point of the grid and apply the <img alt=\"\" src=images/Sketcher_ConstrainCoincident.svg style=\"width:24px;\"> [coincident constraint](Sketcher_ConstrainCoincident.md) to fix your shape.\n\nAt this point you should have a fully constrained sketch as indicated by it changing color and the message shown in the Combo View. It should now look just like the image below.\n\n  \n\nNow in the [Tasks tab](Task_panel.md), click on the **Close** button to leave the sketch edit mode and select <img alt=\"\" src=images/PartDesign_Pad.svg style=\"width:24px;\"> [Pad](PartDesign_Pad.md) from the toolbar or from the Part Design menu. This will give you a Pad dialog in the Task View. Using that dialog, first using the Type pulldown menu, select Two dimensions. Drawing presented at the beginning of this tutorial says the part is 53 mm long. We do it by Padding our sketch both ways from the center plane to make up that distance i.e. make the pad symmetric in relation of sketch-plane. The reason for is seen later when creating features. For now, given we want it to be 53 mm long in total we will input 26.5 for Length, and 26.5 again for the Second length. Alternatively, you can provide a single length of 53 mm and click the Symmetric to plane check box. Once that is done we now have our base solid upon which we will add additional features to construct our part.\n\nA video of the steps used in this portion of the tutorial is here: <https://youtu.be/cUyPnCMeTgg>\n\n### Features with pocket and external geometry \n\nUsing the mouse or the view icons turn the model around so you can see its back. Once the back of the part is visible, select the back face by clicking on it as seen in the next image.\n\n  \n\nAfter the face is selected, click on the New sketch icon in the toolbar or from the Part Design menu and that will map our next sketch to the back face of the part. Now select <img alt=\"\" src=images/Sketcher_CreateRectangle.svg style=\"width:24px;\"> [Rectangle](Sketcher_CreateRectangle.md) tool and place a rectangle on the rear face of the part in a similar fashion as shown below. Now following the steps listed, constrain the sketch.\n\n1. Select one of the horizontal lines apply a horizontal distance constraint and a value of 5 mm.\n2. Select one of the vertical lines and give it a vertical distance constraint and a value of 11 mm.\n3. Select <img alt=\"\" src=images/Sketcher_External.svg style=\"width:24px;\"> [External geometry](Sketcher_External.md) tool\n4. Select the upper right vertex of the face and click it so you are provided a point from the external geometry to link our sketch to.\n\n  \n\n1. Right click to end the External geometry mode\n2. Select that point you just made available with the External geometry tool and then select the upper right vertex of the rectangle and click on the <img alt=\"\" src=images/Sketcher_ConstrainCoincident.svg style=\"width:24px;\"> [Constrain coincident](Sketcher_ConstrainCoincident.md). At this point the sketch should be fully constrained and look like the next image.\n\n  \n\nOnce that is done, click the Close button at the top of the Tasks tab in the Combo View window, then select <img alt=\"\" src=images/PartDesign_Pocket.svg style=\"width:24px;\"> [Pocket](PartDesign_Pocket.md) tool from the toolbar or Part Design menu. Using this tool is the opposite of the Pad tool. As the Pad tool adds material to the part, the Pocket tool removes material from the part. Both operations are called features. In this Pocket operation we want to select Through all from the type pulldown-menu and then click the OK button.\n\nFor the next operation, make sure that \"Pocket\" is selected in the Model tree view and once done, click on the <img alt=\"\" src=images/PartDesign_Mirrored.svg style=\"width:24px;\"> [Mirror](PartDesign_Mirrored.md) feature on the toolbar or from the Part Design menu. In the Mirror dialog in the Combo View, select Horizontal sketch axis from the Plane pulldown menu. Then click OK. The Mirror feature works in this way because the base feature of our model was Padded both ways from the horizontal plane in the first operation with the base sketch. If all has gone well, you should now have a part that looks like the image below after you orbit it around to the front.\n\n  \n\nA video of the steps used in this portion of the tutorial is here: <https://youtu.be/wiGXV9G7mrM>\n\n### Features with pad and external geometry \n\nAfter taking a look, orbit back around and once again select the back face of the part and select that face to map the next sketch to.\n\n  \n\nSelect New sketch and make a new rectangle in the manner similar to what is shown below in the next image. Then proceed to add dimensional constraints to the rectangle.\n\n1. Select a horizontal line and apply a horizontal distance constraint with a value of 16.7.\n2. Select a vertical line and apply a vertical distance constraint of 7 mm\n3. Using the External geometry tool, select the upper left vertex of the part face.\n\n  \n\nNow selecting the upper left vertex of the rectangle and the external geometry point, click on the coincident constraint to fully constrain the sketch.\n\n  \n\nClose the Sketcher.\n\nNext we will click on the Pad feature and in the Pad dialog in the Combo View we want a length of 26 mm leaving the type as Dimension and then placing a check on the Reversed checkbox. Using the Reversed checkbox will cause the Pad to go into the part instead of away from the part. This operation provides with the following result.\n\n  \n\nOnce again use the Mirror feature to get the second pad. First ensure that created Pad is selected in the tree view, then click on Mirror in the toolbar or select it from the Part Design menu. We will repeat the operation we did for Pocket above and select Horizontal sketch axis from the Plane pulldown menu.\n\n  \n\nA video of the steps used in this portion of the tutorial is here: <https://youtu.be/Ido1owp8ubc>\n\n### Feature with pocket and external geometry \n\nAt this point orbiting the part around to the front, we can see that our part is now starting to look like the part in the dimensioned drawing at the beginning of this tutorial. Once you have the view of the front, click on the sloped face with your mouse to select the face we will use for the next sketch.\n\n  \n\nHere we will use the Rectangle tool and place a rectangle in our sketch and once having done so, apply the following constraints.\n\n1. Select a horizontal line and a vertical line, and after both are selected, click on the Equals constraint.\n2. Select either a horizontal or vertical line and apply a corresponding horizontal or vertical distance constraint with a value of 17 mm\n3. Using the External geometry tool, select the top right vertex as shown in the image below.\n\n  \n\nNow using the dimensions from the drawing, apply the following constraints.\n\n1. Select the external geometry point and the upper right vertex of the now square sketch and apply a horizontal distance constraint of 7 mm\n2. Select the external geometry point and the upper right vertex of the now square sketch and apply a vertical distance constraint of 11 mm\n\nThe result should be as follows.\n\n  \n\nAt this point if we were to simply Pocket this sketch, the resulting hole would be perpendicular to the sloped face that it is mapped to, and this is not what we want.\n\n\n\nWe want the hole to be perpendicular to the back face, but it\\'s projected dimensions are not the 17 mm x 17 mm dimensions that are given in the drawing. Now we could do the math and calculate the dimensions needed, or we can use the tools provided in FreeCAD to make that projection for us.\n\nA video of the steps used in this portion of the tutorial is here: <https://youtu.be/x4d5nZPWCLQ>\n\nTo create pocket which has the sloped rectangle as it´s outlet, we draw a new rectangle on the rear side, using the projection of the sloped rectangle as an external reference. Orbit the Solid around to see the rear face of the part once again and select the back face to map the final sketch to.\n\n  \n\nSelect <img alt=\"\" src=images/PartDesign_NewSketch.svg style=\"width:24px;\"> [New Sketch](PartDesign_NewSketch.md) from the toolbar or Part Design menu. Now in sketch edit mode, we do not see the sketched rectangle on the slope. To make it selectable , we switch the combo view to model tab and select the last sketch made (Sketch003) on the sloped plane. Then using the spacebar, make it visible. Next, select the mirror feature above (mirrored001) and again using the spacebar, hide it. Then you should see the sloped rectangle inside the 3D View. You may continue to work with the model tab visible, or switch back to tasks tab. Using the <img alt=\"\" src=images/Sketcher_External.svg style=\"width:24px;\"> [External geometry](Sketcher_External.md) tool, select the upper and lower horizontal edges of the sloped rectangle. Then, add a new rectangle to the sketch using the <img alt=\"\" src=images/Sketcher_CreateRectangle.svg style=\"width:24px;\"> [Rectangle](Sketcher_CreateRectangle.md) tool.\n\n  \n\n1. Select the upper left vertex of the new rectangle and the upper left point of the external geometry and click on the coincident constraint.\n2. Click on the lower right vertex of the new rectangle and the lower right point of the external geometry and click on the coincident constraint.\n\nAnd we should end up with this.\n\n  \n\nFor the final step in this tutorial, close the sketcher window using close or finish editing from the context menu of sketch004 and then select the <img alt=\"\" src=images/PartDesign_Pocket.svg style=\"width:24px;\"> [Pocket](PartDesign_Pocket.md) feature from the toolbar or from the Part Design menu. From the Type pulldown select **Through all** and click the OK button.\n\n  \n\nAt this point, you will see some lines which come from intersecting features. In this case the *side block* intersects with the *base profile* letting it appear as a triangular block above the profile (i.e., there is an extra line visible in the above picture on the right face of the model). To remove these lines, you can either switch on \\\"refine shape\\\" in your Part Design Settings or, to save some processing speed and still have these lines while constructing, individually switch it on at each feature. The Setting on feature level can be done in the \\\"data\\\" tab of the feature. Set the [***refine* property**](Property_editor#Data.md) to TRUE for the pocket feature Pocket001 to invoke refining.\n\n   \n\nA video of these steps of the tutorial is here: <https://youtu.be/UYI0gvxCYeI>\n\nThis tutorial and your model are complete.\n\n## Additional Resources \n\n- FreeCAD file for comparison (made with 0.17) [Download](https://github.com/FreeCAD/Examples/blob/master/Basic_Part_Design_Tutorial_Example_017_Files/Basic_Part_Design_Tutorial_017.fcstd)\n\n\n{{PartDesign Tools navi\n\n}} {{Sketcher Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](Category_PartDesign.md) > [Sketcher](Category_Sketcher.md) > Basic Part Design Tutorial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 4253, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_Copy.md", "text": "---\n GuiCommand:\n Name: CAM Copy\n MenuLocation: CAM , Path Modification , Copy the operation in the job\n Workbenches: CAM_Workbench\n---\n\n# CAM Copy\n\n## Description\n\nThe tool <img alt=\"\" src=images/CAM_Copy.svg style=\"width:24px;\"> [Copy](CAM_Copy.md) creates a copy of a selected path.\n\n## Usage\n\n1. Select a <img alt=\"\" src=images/Workbench_CAM.svg style=\"width:24px;\"> [CAM](CAM_Workbench.md) object\n2. There are several ways to invoke the command:\n - Press the **<img src=\"images/CAM_Copy.svg\" width=24px> [Copy the operation in the job](CAM_Copy.md)** button in the CAM toolbar\n - Use the **P** then **Y** keyboard shortcut\n - Use the **CAM → Path Modification → Copy the operation in the job** entry in the CAM menu\n\n## Properties\n\n- **Base**: The base path to be copied\n\n## Options\n\nThe copy stays linked with the original path. If the original changes, so does the copy.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Copy\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 277, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_Slot.md", "text": "---\n GuiCommand:\n Name: CAM Slot\n MenuLocation: CAM , Slot\n Workbenches: CAM_Workbench\n Version: 0.19\n---\n\n# CAM Slot\n\n## Description\n\nThe <img alt=\"\" src=images/CAM_Slot.svg style=\"width:24px;\"> [Slot](CAM_Slot.md) tool creates a simple slotting operation using various methods of input.\n\nInputs include:\n\n- selecting one or more faces or edges.\n- selecting two vertices.\n- entering two custom points.\n\nThe CAM Slot object is made to be part of a <img alt=\"\" src=images/CAM_Job.svg style=\"width:24px;\"> [CAM Job](CAM_Job.md).\n\n## Usage\n\n1. Select the reference geometry on the model:\n - one or more faces or edges.\n - two vertices.\n - ***nothing*** to use two custom points entered in the Property View of the Data tab: Custom Point1 and Custom Point2.\n2. Invoke the Slot command using several methods:\n - Pressing the **<img src=\"images/CAM_Slot.svg\" width=24px> [Slot](CAM_Slot.md)** button in the toolbar.\n\n#\\* Using the ** CAM** → **<img src=\"images/CAM_Slot.svg\" width=24px> [Slot](CAM_Slot.md)** entry from the top menu.\n\n1. Adjust the desired properties. Descriptions of available properties are found below.\n\n#### Usage Notes \n\n- All slots:\n - Both the beginning and end of a slot path can be extended or shortened. Use the \\Extend Path Start\\ and \\Extend Path End\\ properties.\n - Use the \\Layer Mode\\ property to cut the slot in \\Single-pass\\ mode at final depth, or in \\Multi-pass\\ mode using the available \\Step Down\\ property.\n - Toggle the \\Reverse Direction\\ property to reverse the direction of the cut path.\n\n- Linear slots:\n - Currently there is no capability to offset linear slots laterally (parallel to path of travel). ***Example:*** Say you have a tool diameter smaller than the width of the slot area you are clearing. Current behavior of this operation is to create a set of paths on a plane down the center-line of the designated slot, which will result in the slot volume not being fully cleared. Some users would want the operation to create multiple paths that are offset laterally to clear the entire slot area; this not directly possible, though can be achieved through using \\\"Custom Points\\\", see \\\"Vertical face milling\\\" below. Alternatively use the Pocket operation for such clearing.\n - Create a custom linear slot using the \\Custom Point1\\ and \\Custom Point2\\ properties with no geometry selection. ***Example:*** Initiate a Slot operation in the GUI and click \\OK\\ to save. Now locate and edit the \\Custom Point1\\ and \\Custom Point2\\ properties in the Data tab of the newly created Slot operation. Recompute the operation to update the path.\n\n- Vertical face milling:\n - Most of the CAM tools cannot make a path on a single vertical plane since the projection onto horizontal plane has zero area (an internal limitation). The Slot operation makes this possible by selecting \\\"Custom points\\\" which define a line parallel to the vertical plane and suitable Depth parameters.\n\n- Arc/Circular slots:\n - Creating arc/circular slots\n 1. You will need to select one bottom arc of the slot. This will produce a path directly on the arc edge you selected.\n 2. You will then need to edit the \\Extend Radius\\ property in the Data tab of the operation. Using the expression editor, set it to either \\OpToolDiameter / 2.0\\ or the negative version \\OpToolDiameter / -2.0\\ as needed, depending on whether you selected the inside or outside arc of the slot.\n 3. Recompute the operation.\n 4. Keep in mind that if the toolbit diameter is not equal to the slot width, the path will ***not*** be in the correct location. In this case, adjust the value in the \\Extend Radius\\ property mentioned above.\n - Currently users are unable to create a custom arc/circular path. A third \\Custom Center\\ property will need to be added, along with additional modifications to the code base.\n\n## Properties\n\n***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.\n\n\n{{TitleProperty|Base}}\n\nNote: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the CAM Job model as needed.\n\n- **Placement**: Overall placement\\[position and rotation\\] of the object - with respect to the origin (or origin of parent object container)\n\n - \n **Angle**\n \n : Angle in degrees applied to rotation of the object around Axis property value\n\n - \n **Axis**\n \n : Axis (one or multiple) around which to rotate the object, set in sub-properties: X, Y, Z\n\n - \n **X**\n \n : X axis value\n\n - \n **Y**\n \n : Y axis value\n\n - \n **Z**\n \n : Z axis value\n\n - \n **Position**\n \n : Position of the object, set in sub-properties: X, Y, Z - with respect to the origin (or origin of parent object container)\n\n - \n **X**\n \n : X distance value\n\n - \n **Y**\n \n : Y distance value\n\n - \n **Z**\n \n : Z distance value\n\n- **Label**: User-provided name of the object (UTF-8)\n\n\n{{TitleProperty|Depth}}\n\n- **Clearance Height**: The height needed to clear clamps and obstructions\n\n- **Final Depth**: Final Depth of Tool- lowest value in Z\n\n- **Finish Depth**: Maximum material removed on final pass. The height (thickness) of the last cutting level - *set for a better finish*.\n\n- **Safe Height**: The height above which Rapid motions are allowed. (Rapid safety height between locations)\n\n- **Start Depth**: Starting depth of Tool - *first cut depth in Z*\n\n- **Step Down**: Incremental step down of Tool during operation\n\n <img alt=\"\" src=images/Path-DepthsAndHeights.gif style=\"width:300px;\"> \n*Visual reference for Depth properties (settings)*\n\n\n{{TitleProperty|Path}}\n\n- **Active**: Make False, to prevent operation from generating code\n\n- **Base**: The base geometry for this operation\n\n- **Comment**: An optional comment for this Operation\n\n- **Coolant Mode**: The coolant mode for this operation.\n\n- **Cycle Time**: The cycle time estimation for this operation.\n\n- **Tool Controller**: Defines the Tool controller used in the Operation\n\n- **User Label**: User assigned label\n\n\n{{TitleProperty|Slot}}\n\n- **Custom Point1**: Enter custom start point for slot path.\n\n- **Custom Point2**: Enter custom end point for slot path.\n\n- **Cut Pattern**: Set the geometric clearing pattern to use for the operation.\n\n- **Extend Path End**: Positive extends the end of the path, negative shortens.\n\n- **Extend Path Start**: Positive extends the beginning of the path, negative shortens.\n\n- **Extend Radius**: For arcs/circlular edges, offset the radius for the path.\n\n- **Layer Mode**: Complete the operation in a single pass at depth, or mulitiple passes to final depth.\n\n- **Path Orientation**: Choose the path orientation with regard to the feature(s) selected.\n\n- **Reference1**: Choose what point to use on the first selected feature.\n\n- **Reference2**: Choose what point to use on the second selected feature.\n\n- **Reverse Direction**: Enable to reverse the cut direction of the slot path.\n\n\n{{TitleProperty|Start Point}}\n\n- **Start Point**: The custom start point for the path of this operation.\n\n - \n **X**\n \n : X distance value\n\n - \n **Y**\n \n : Y distance value\n\n - \n **Z**\n \n : Z distance value\n\n- **Use Start Point**: Make True, if manually specifying a Start Point. Set the start point in the property data Start Point field.\n\n## Tasks Window Editor Layout \n\n*Descriptions for the settings are provided in the Properties list above.*\n\nThis section is simply a layout map of the settings in the window editor for the Operation.\n\n### Base Geometry \n\n- **Add**: Adds selected element(s) which should be the base(s) for the path(s)\n- **Delete**: Delete the selected item(s) in the Base Geometry list\n- **Clear**: Clear all items in the Base Geometry list\n\n### Depths\n\n- **Start Depth**\n \n\n- **Final Depth**\n \n\n- **Step Down**\n \n\n### Heights\n\n- **Safe Height**\n \n\n- **Clearance Height**\n \n\n### Operation\n\n- **Tool Controller**: The tool and its settings to be used for this operation.\n\n- **Coolant Mode**: Coolant mode for this operation.\n\n- **Start Reference ****: Choose what point to use on the first selected feature.\n\n- **End Reference ****: Choose what point to use on the second selected feature.\n\n- **Extend Path End**: Positive extends the end of the path, negative shortens.\n\n- **Extend Path Start**: Positive extends the beginning of the path, negative shortens.\n\n- **Layer Mode**: Complete the operation in a single pass at depth, or mulitiple passes to final depth.\n\n- **Path Orientation ****: Choose the path orientation with regard to the feature(s) selected.\n\n- **Reverse Direction**: Enable to reverse the cut direction of the slot path.\n\n**\\*\\*** Visibility changes depending on Base Geometry selected.\n\n## Scripting\n\n\n**See also:**\n\n[FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nExample:\n\n \n```python\n#Place code example here.\n```\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Slot\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2177, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_Tools.md", "text": "# CAM Tools\n## Description\n\nThis page describes the ToolBit architecture used in the [CAM Workbench](CAM_Workbench.md) which became the default for FreeCAD V0.19. Tools in the CAM workbench are handled differently than in other [CAM](https://en.wikipedia.org/wiki/Computer-aided_manufacturing) packages.\n\nThere are several concepts that the user needs to understand:\n\n- [CAM ToolShapes](CAM_ToolShape.md): 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.\n\n- [CAM ToolBits](CAM_ToolBit.md): 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 CAM Job through a Tool Controller (TC). The same toolbit can exist in multiple libraries.\n\n- [CAM ToolBit Library](CAM_ToolBit_Library.md): contains an arbitrary collection of toolbits. The specific tools in a library is entirely up to the user. Possible use cases for libraries:\n - A hobbyist user may have only one library for all of the tools they own.\n - A library may contain all the tools used for a specific material like aluminum or wood.\n - A library may have toolbits for working on specific material.\n - A library may hold toolbits from a specific supplier.\n - A library may correspond to an automatic tool changer layout.\n\nA [Tool Controller](CAM_ToolController.md) controls how a tool is used in a CAM Job. A controller combines the toolbit with properties for spindle speed, direction and Horizontal/Vertical feed rates.\n\n## Dialogs\n\nThe user will interact via CAM menu with the tool management system in two different workflows. Each workflow has dedicated GUI elements.\n\n- **<img src=\"images/CAM_ToolBitLibraryOpen.svg\" width=24px> [Toolbit Dock](CAM_ToolBitDock.md)**view indicated at the box top as *Tool selector*, for using tools in a CAM Job by creating Tool Controllers.\n\n- **<img src=\"images/CAM_ToolBitDock.svg\" width=24px> [Toolbit Library Manager](CAM_ToolBitLibraryOpen.md)**for managing the user\\'s Toolbit collection with *Create Toolbit*, *Add Existing* and *Remove* buttons.\n\n## Organization\n\nWhen FreeCAD is installed an example hierarchy of tool libraries and toolbits is created in the installation directory at:\n\n- On Linux it is usually **/usr/lib64/FreeCAD/Mod/CAM/Tools**\n- On Windows it is usually **C:\\Program Files\\FreeCAD\\Mod\\CAM\\Tools**\n- On macOS it is usually **/Applications/FreeCAD.app/Contents/Resources/Mod/CAM/Tools**\n\n\n Tools\n + Bit\n + Library\n + Shape\n\nIt is always recommended to store the new created toolbits and libraries in a safe location to avoid them being overwritten on a program upgrade. Even custom toolshapes can be stored in arbitrary locations where they can be backed up. The user is encouraged, however, to use a comparable logical structure as shown above to keep toolbits and libraries well organized.\n\nWhen the Tool library Manager is opened, CAM checks the location of the working directory. If the location is not writeable or is the same as the example/default location, CAM will prompt the user to select or create a new working directory, which usually defaults to the your user macro directory.\n\nCopies of the default toolbits and library are copied to this directory. You can now manage your tools, for example copy, edit and create toolshapes, toolbits and libraries and your changes will be preserved. Note that toolshapes are not copied, as having duplicates may cause issues. See issue [CAM: Tool shapes not copied by \\\"Setup ToolBit working directory\\\" #15275](https://github.com/FreeCAD/FreeCAD/issues/15275).\n\n## Options\n\nReferences 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.\n\nSee [CAM Preferences](CAM_Preferences.md) to choose whether absolute or relative paths are used.\n\n## Migrating from Legacy Tools \n\nIf you have been using FreeCAD CAM workbench for a while, you may need to adjust your preferences before you can use the Toolbit system. If pressing the Tool Library button on the toolbar shows the legacy dialog, go to the page below in [CAM Preferences](CAM_Preferences.md) and disable legacy tools.\nYou have to restart FreeCAD to make the change valid.\n\n\n\n## Getting Started with Tools in FC 0.19 \n\nRead the [Migrating from Legacy Tools](#Migrating_from_Legacy_Tools.md) section above. The steps below will walk you through the process of getting a ToolBit into your particular **<img src=\"images/CAM_Job.svg\" width=16px> [CAM Job](CAM_Job.md)**.\n\nIn short, the process begins with a Tool Shape (profile) file that contains only a FreeCAD sketch of half the tool\\'s physical shape (profile). This tool shape file is then used as the basis to create a ToolBit file containing the 3D representation of the ToolBit or cutter. One or more ToolBits are assigned to any number of Tool Libraries as needed by the user. This structure and workflow allows for sharing of Tool Shapes, ToolBits, and entire Tool Libraries - a giant leap forward from the Legacy tool management system in place prior to version 0.19.\n\n### Verify or create a Tool Shape \n\nGetting a cutter or tool into a CAM Job for use in operations starts with a [Tool Shape](CAM_ToolShape.md). This step of verification or creation of a Tool Shape is not necessary if you already have an existing ToolBit available.\n\n#### Verify your desired Tool Shape exists \n\n- FreeCAD includes a set of common tool shapes with each distribution. Visit the [ToolShapes](CAM_ToolShape.md) page to see the list of included, common tool shapes.\n- You might have additional tool shape files available in your personal files.\n- Be mindful of the greater ToolBit system [organization](CAM_Tools#Organization.md) as mentioned above.\n\n#### Create a new Tool Shape \n\n: Follow the instructions outlined in the [Usage](CAM_ToolShape#Usage.md) section of the [Tool Shape](CAM_ToolShape.md) page to create a custom tool shape.\n\n### Load or create a ToolBit \n\nOnce the desired tool shape(profile) exists, you need to create a [tool bit](CAM_ToolBit.md) using the tool shape (profile).\n\n1. In the <img alt=\"\" src=images/Workbench_CAM.svg style=\"width:24px;\"> [CAM Workbench](CAM_Workbench.md) menu bar, navigate to **CAM → Create Tool**.\n2. In the [Tool Bit](CAM_ToolBit.md) creation task panel that appears, give the new tool bit a name and select the corresponding tool shape file as the basis for this new tool bit.\n3. A thumbnail of the selected tool shape should appear along with a list of parameters.\n4. Set the Bit Parameters as desired.\n5. Click **OK** to save the new tool bit.\n6. The new Tool Bit will appear in the FreeCAD object tree.\n\n### Save the new ToolBit \n\n1. Locate and select the new tool bit in the object tree in the main FreeCAD window.\n2. In the <img alt=\"\" src=images/Workbench_CAM.svg style=\"width:24px;\"> [CAM Workbench](CAM_Workbench.md) menu bar, navigate to, and select, **CAM → Save Tool as...**.\n3. A pop-up window will appear.\n4. Navigate to the folder where you wish to save the new tool bit file.\n5. Enter a file name for the tool bit.\n6. Click the **Save** button.\n\n### Register the ToolBit in a Tool Library \n\n1. In the <img alt=\"\" src=images/Workbench_CAM.svg style=\"width:24px;\"> [CAM Workbench](CAM_Workbench.md) menu bar, navigate to **CAM → Open ToolBit Library editor**.\n2. The [ToolBit Library Manager](CAM_ToolBitLibraryOpen.md) window will open.\n3. At the top of this window, verify or set the path to the folder containing your existing tool libraries, or the location you want to store your tool libraries.\n4. Under the path entry, on the left is the Tool Libraries list area. Click on an existing tool library you wish to use as the destination for your new tool bit, or click the green plus icon to create new Tool Library in the folder identified above.\n5. On the right side of the Tool Library editor window is the Tool Bit list and action buttons for the currently selected tool library. Click the **Add ToolBit** icon.\n6. In the file navigation window that opens, navigate to your new tool bit, select it, and click the **Open** button. The new tool bit will be added to the active tool library.\n7. Be sure to click the **Save Table** button at the bottom of the Tool Library window in order to save the changes.\n8. Leave this ToolBit Library window open for the next step.\n9. Once your ToolBits are created and saved in a ToolBit Library, you may reuse them.\n\n### Add a ToolBit Tool Controller to a Job \n\n1. In the open Tool Library window, locate and activate the desired tool library.\n2. Select the desired tool bit(s) to be added to the Job. Select multiple by holding down the CTRL key when selecting.\n3. Click the **Add Tool Controller to Job** button.\n4. Close the ToolBit Library\n\n## Related\n\n- [CAM ToolBit](CAM_ToolBit.md)\n- [CAM ToolBitLibraryOpen](CAM_ToolBitLibraryOpen.md)\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Tools\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2200, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_EM.md", "text": "# Category:EM\nThis category list pages related to the [EM Workbench](EM_Workbench.md) which is one of the [external workbenches](external_workbenches.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [EM FHEquiv](EM_FHEquiv.md) | [EM FHInputFile](EM_FHInputFile.md) | [EM FHNode](EM_FHNode.md) |\n| [EM FHPath](EM_FHPath.md) | [EM FHPlane](EM_FHPlane.md) | [EM FHPlaneAddRemoveNodeHole](EM_FHPlaneAddRemoveNodeHole.md) |\n| [EM FHPlaneHole](EM_FHPlaneHole.md) | [EM FHPort](EM_FHPort.md) | [EM FHSegment](EM_FHSegment.md) |\n| [EM FHSolver](EM_FHSolver.md) | [Template:EM Tools navi](Template_EM_Tools_navi.md) | [EM Workbench](EM_Workbench.md) |\n|\n\n\n---\n⏵ [documentation index](../README.md) > Category:EM\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 246, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_External_Command_Reference.md", "text": "# Category:External Command Reference\nThis categorizes all **external** workbench commands separate from the internal [:Category:Command_Reference](:Category_Command_Reference.md)\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [CurvedShapes CurvedArray](CurvedShapes_CurvedArray.md) | [Curves CompressionSpring](Curves_CompressionSpring.md) | [Curves Discretize](Curves_Discretize.md) |\n| [Curves EditableSpline](Curves_EditableSpline.md) | [Curves ExtendCurve](Curves_ExtendCurve.md) | [Curves GordonSurface](Curves_GordonSurface.md) |\n| [Curves Interpolate](Curves_Interpolate.md) | [Curves IsoCurve](Curves_IsoCurve.md) | [Curves JoinCurve](Curves_JoinCurve.md) |\n| [Curves Line](Curves_Line.md) | [Curves MultiLoft](Curves_MultiLoft.md) | [Curves ParametricComb](Curves_ParametricComb.md) |\n| [Curves ParametricSolid](Curves_ParametricSolid.md) | [Curves PasteSVG](Curves_PasteSVG.md) | [Curves Pipeshell](Curves_Pipeshell.md) |\n| [Curves PipeshellProfile](Curves_PipeshellProfile.md) | [Curves ProfileSupport](Curves_ProfileSupport.md) | [Curves ReflectLines](Curves_ReflectLines.md) |\n| [Curves SegmentSurface](Curves_SegmentSurface.md) | [Curves SketchOnSurface](Curves_SketchOnSurface.md) | [Curves SplitCurve](Curves_SplitCurve.md) |\n| [Curves ToConsole](Curves_ToConsole.md) | [Template:Curves Tools navi](Template_Curves_Tools_navi.md) | [Curves Workbench](Curves_Workbench.md) |\n| [Curves ZebraTool](Curves_ZebraTool.md) | [Design456 2DExtend](Design456_2DExtend.md) | [Design456 2DTrim](Design456_2DTrim.md) |\n| [Design456 3Point](Design456_3Point.md) | [Design456 Extract](Design456_Extract.md) | [Design456 Extrude](Design456_Extrude.md) |\n| [Design456 ExtrudeFace](Design456_ExtrudeFace.md) | [Design456 LoftOnDirection](Design456_LoftOnDirection.md) | [Design456 MultiPointsToWireClose](Design456_MultiPointsToWireClose.md) |\n| [Design456 MultiPointsToWireOpen](Design456_MultiPointsToWireOpen.md) | [Design456 PartMerge](Design456_PartMerge.md) | [Design456 PartSubtract](Design456_PartSubtract.md) |\n| [Design456 SplitObject](Design456_SplitObject.md) | [EM FHEquiv](EM_FHEquiv.md) | [EM FHInputFile](EM_FHInputFile.md) |\n| [EM FHNode](EM_FHNode.md) | [EM FHPath](EM_FHPath.md) | [EM FHPlane](EM_FHPlane.md) |\n| [EM FHPlaneAddRemoveNodeHole](EM_FHPlaneAddRemoveNodeHole.md) | [EM FHPlaneHole](EM_FHPlaneHole.md) | [EM FHPort](EM_FHPort.md) |\n| [EM FHSegment](EM_FHSegment.md) | [EM FHSolver](EM_FHSolver.md) | [EM Workbench](EM_Workbench.md) |\n| [Example Combined Footing](Example_Combined_Footing.md) | [Example Slab Having LShape Rebars Reinforcement Mesh](Example_Slab_Having_LShape_Rebars_Reinforcement_Mesh.md) | [Example Slab Having Mesh Of Straight Rebars](Example_Slab_Having_Mesh_Of_Straight_Rebars.md) |\n| [Example Slab Having UShape Rebars Reinforcement Mesh](Example_Slab_Having_UShape_Rebars_Reinforcement_Mesh.md) | [Example Slab Spanning in One Direction](Example_Slab_Spanning_in_One_Direction.md) | [Example Slab Spanning in Two Directions](Example_Slab_Spanning_in_Two_Directions.md) |\n| [Fasteners BOM](Fasteners_BOM.md) | [Fasteners ChamferHole](Fasteners_ChamferHole.md) | [Fasteners ChangeParameters](Fasteners_ChangeParameters.md) |\n| [Fasteners Flip](Fasteners_Flip.md) | [Fasteners MatchTypeInner](Fasteners_MatchTypeInner.md) | [Fasteners MatchTypeOuter](Fasteners_MatchTypeOuter.md) |\n| [Fasteners Move](Fasteners_Move.md) | [Fasteners ScrewCalculator](Fasteners_ScrewCalculator.md) | [Fasteners Simplify](Fasteners_Simplify.md) |\n| [FCGear BevelGear](FCGear_BevelGear.md) | [FCGear CrownGear](FCGear_CrownGear.md) | [FCGear CycloidGear](FCGear_CycloidGear.md) |\n| [FCGear CycloidRack](FCGear_CycloidRack.md) | [FCGear GearConnector](FCGear_GearConnector.md) | [FCGear HypoCycloidGear](FCGear_HypoCycloidGear.md) |\n| [FCGear InternalInvoluteGear](FCGear_InternalInvoluteGear.md) | [FCGear InvoluteGear](FCGear_InvoluteGear.md) | [FCGear InvoluteRack](FCGear_InvoluteRack.md) |\n| [FCGear LanternGear](FCGear_LanternGear.md) | [FCGear TimingGear](FCGear_TimingGear.md) | [FCGear WormGear](FCGear_WormGear.md) |\n| [FreeGrid BitCartridgeHolder](FreeGrid_BitCartridgeHolder.md) | [FreeGrid Sketch](FreeGrid_Sketch.md) | [FreeGrid StorageBox](FreeGrid_StorageBox.md) |\n| [FreeGrid StorageGrid](FreeGrid_StorageGrid.md) | [Lattice2 AttachablePlacement](Lattice2_AttachablePlacement.md) | [Movie MovieCamera](Movie_MovieCamera.md) |\n| [Movie Workbench](Movie_Workbench.md) | [Reinforcement BarBendingSchedule](Reinforcement_BarBendingSchedule.md) | [Reinforcement BarShapeCutList](Reinforcement_BarShapeCutList.md) |\n| [Reinforcement BeamRebars](Reinforcement_BeamRebars.md) | [Reinforcement BentShapeRebar](Reinforcement_BentShapeRebar.md) | [Reinforcement BillOfMaterial](Reinforcement_BillOfMaterial.md) |\n| [Reinforcement ColumnRebars](Reinforcement_ColumnRebars.md) | [Reinforcement ColumnRebars Circular](Reinforcement_ColumnRebars_Circular.md) | [Reinforcement ColumnRebars TwoTiesSixRebars](Reinforcement_ColumnRebars_TwoTiesSixRebars.md) |\n| [Reinforcement DrawingDimensioning](Reinforcement_DrawingDimensioning.md) | [Reinforcement FootingRebars](Reinforcement_FootingRebars.md) | [Reinforcement HelicalRebar](Reinforcement_HelicalRebar.md) |\n| [Reinforcement LShapeRebar](Reinforcement_LShapeRebar.md) | [Reinforcement SlabRebars](Reinforcement_SlabRebars.md) | [Reinforcement StirrupRebar](Reinforcement_StirrupRebar.md) |\n| [Reinforcement StraightRebar](Reinforcement_StraightRebar.md) | [Reinforcement UShapeRebar](Reinforcement_UShapeRebar.md) | [Render Workbench](Render_Workbench.md) |\n| [SheetMetal AddBase](SheetMetal_AddBase.md) | [SheetMetal AddBend](SheetMetal_AddBend.md) | [SheetMetal AddCornerRelief](SheetMetal_AddCornerRelief.md) |\n| [SheetMetal AddCutout](SheetMetal_AddCutout.md) | [SheetMetal AddFoldWall](SheetMetal_AddFoldWall.md) | [SheetMetal AddJunction](SheetMetal_AddJunction.md) |\n| [SheetMetal AddRelief](SheetMetal_AddRelief.md) | [SheetMetal AddWall](SheetMetal_AddWall.md) | [SheetMetal BaseShape](SheetMetal_BaseShape.md) |\n| [SheetMetal Examples](SheetMetal_Examples.md) | [SheetMetal Extrude](SheetMetal_Extrude.md) | [SheetMetal Forming](SheetMetal_Forming.md) |\n| [SheetMetal SketchOnSheet](SheetMetal_SketchOnSheet.md) | [SheetMetal UnattendedUnfold](SheetMetal_UnattendedUnfold.md) | [SheetMetal Unfold](SheetMetal_Unfold.md) |\n| [SheetMetal UnfoldUpdate](SheetMetal_UnfoldUpdate.md) | [SheetMetal Workbench](SheetMetal_Workbench.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:External Command Reference\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1956, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Packaging.md", "text": "# Category:Packaging\nThis category collects pages related to packing FreeCAD for different platforms, including Linux, Windows, and MacOS.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [AppImage](AppImage.md) | [Debian development](Debian_development.md) | [Debian Unstable](Debian_Unstable.md) |\n| [Flatpak](Flatpak.md) | [Git buildpackage](Git_buildpackage.md) | [Linux packaging](Linux_packaging.md) |\n| [MacOS packaging](MacOS_packaging.md) | [Packaging](Packaging.md) | [Ubuntu Snap](Ubuntu_Snap.md) |\n| [Windows packaging](Windows_packaging.md) | [Windows packaging/en](Windows_packaging/en.md) | [Windows packaging/pl](Windows_packaging/pl.md) |\n| [Windows packaging/pt-br](Windows_packaging/pt-br.md) | [Windows packaging/ru](Windows_packaging/ru.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Packaging\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 227, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Testing.md", "text": "# Category:Testing\nPages related to testing in regards to unit testing, continuous integration, quality assurance, regression testing etc\\...\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [AppImage](AppImage.md) | [Artwork Test](Artwork_Test.md) | [Continuous Integration](Continuous_Integration.md) |\n| [Flatpak](Flatpak.md) | [LGTM](LGTM.md) | [Testing](Testing.md) |\n| [Ubuntu Snap](Ubuntu_Snap.md) | [Category:Test Framework](Category_Test_Framework.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Testing\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 141, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Continuous_Integration.md", "text": "# Continuous Integration\n## Continuous Integration \n\nCurrently the FreeCAD repository on GitHub will trigger a build on several CI systems. Between these systems pretty much all the main OSs are coveredː Linux, macOS, and Windows. CIs can also be used to run [unit tests](Testing.md).\n\n## Tips\n\n- If you add {{Incode|[skip ci]}} or {{Incode|[ci skip]}} to a git commit it will cancel a CI build.\n\n## Relevant links \n\n- Forum post announcing new CIs: [New CI is yours :)](https://forum.freecad.org/viewtopic.php?p=657956)\n\n\n---\n⏵ [documentation index](../README.md) > [Developer_Documentation](Category_Developer_Documentation.md) > [Testing](Category_Testing.md) > Continuous Integration\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 172, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Creating_a_simple_part_with_Part_WB.md", "text": "---\n TutorialInfo:\n Topic: Modeling\n Level: Beginner\n Author: heda\n Time: 2 hours\n FCVersion: 0.19 or above\n Files: \n SeeAlso: Creating_a_simple_part_with_PartDesign, Creating_a_simple_part_with_Draft_and_Part_WB\n---\n\n# Creating a simple part with Part WB\n\n \n\n\n## Introduction\n\nThis tutorial aims to be used as a first introduction to 3D modeling using the [Part Workbench](Part_Workbench.md)  of FreeCAD. After having finished this tutorial you should be able to make simple 3D models by using primitives like cubes, cylinders, etc with a technique called [Constructive Solid Geometry](https://en.wikipedia.org/wiki/Constructive_solid_geometry), short **CSG** modeling. Another way to create 3D models is by using a 2D shape by for example extruding or revolving the 2D shape in 3D space. For an introduction of that technique please follow the sister-tutorial *[Creating a simple part with PartDesign](Creating_a_simple_part_with_PartDesign.md)*. The two tutorials intentionally have exactly the same model generated, this presents the beginner with a hands on experience of the two different techniques and how they are implemented in FreeCAD. The definition of the two techniques can be viewed as strictly divided from a semantic point of view, however there is nothing directly hindering a mix of the techniques when creating models. There are some caveats to watch out for when mixing modeling techniques, those are mainly related to aspects of how FreeCAD is programmed. There is a [third tutorial](Creating_a_simple_part_with_Draft_and_Part_WB.md) intended as a first introduction to a mixed modeling example. That tutorial uses the **Draft Workbench** to create a 2D profile utilized to extrude a solid in the **Part Workbench** to make the same model as in this tutorial.\n\nBefore you start please have a look at how to **[navigate](Mouse_navigation.md)** in 3D space. When hoovering over the mouse model selector in the lower right corner of the FreeCAD window, a cheat-sheet of the current mouse model appears as in the picture below.\n\n  \n\nMany newcomers to CAD programs get stuck while learning the software, if that happens to you, please go ahead and search the wiki or forum for further information -- chances are that others also have been stuck on the same specific thing in the past so there is already an answer to your specific question. Or make a post on the forum with your questions or findings. The forum has several threads where users are helped to complete all sorts of different tasks, those threads are often similar to tutorials, and often have specific illustrations included.\n\n### The tutorial covers \n\n- The model to make\n- Using the Part Workbench to create and manipulate the primitive building blocks\n- Changing the color and transparency\n- A different way to locate the hole\n- Making the hole a countersunk hole\n- Making a hollow piece\n- A different way to position the chamfer\n- Editing dimensions\n- Organizing the tree a bit differently\n- Wrapping up\n\n## The model to make \n\n <img alt=\"\" src=images/GGTuto1_Vue.PNG style=\"width:372px;\">\n\n \n\n## Using the Part Workbench to create and manipulate the primitive building blocks \n\nCreate a new document and save it directly under a new name, it is good practice to make sure that you save the document at regular intervals, or just before larger operations. Then switch to the **[Part Workbench](Part_Workbench.md)** using either the [workbench selector](Getting_started#Exploring_the_interface.md) (labeled 10 in the linked image) or by going to the **View → Workbench** menu. FreeCAD will start with toolbars at the top, the combo view to the left and the 3D view at the right.\n\n### Create the main solid block \n\nPress <img alt=\"\" src=images/Part_Box.svg style=\"width:24px;\"> [Box](Part_Box.md) to make a default solid cube. The cube appears in the [3D view](3D_view.md) and also as a new object in the [Tree view](Tree_view.md) in the sidebar.\n\nPress <img alt=\"\" src=images/Std_ViewIsometric.svg style=\"width:24px;\"> [Isometric](Std_ViewIsometric.md) to see the cube in 3D.\n\n  \n\nSelect the cube in the [Tree view](Tree_view.md), it becomes green in the 3D view. Below the tree view you will now see that the cube by default is created with the dimensions **Length x Width x Height** as *10 x 10 x 10 mm*. Change those dimensions to **100 x 30 x 50** as per the initial drawing of the model.\n\n  \n\nWhen changing a property, like *Length* through the spinbox, one can either enter the values, or use the scroll-wheel to tick values up or down. The arrows for ticking values up or down can of course also be used. In the right most picture above, the *Height* property is in edit mode, rolling the scroll wheel when the mouse is over that cell will change the value by one up or down.\n\nClick <img alt=\"\" src=images/Std_ViewFitAll.svg style=\"width:24px;\"> **[Fit all](Std_ViewFitAll.md)** to see the whole cube.\n\n  \n\n### Create the fillet \n\nTo make the filleted corner, in the toolbar press <img alt=\"\" src=images/Part_Fillet.svg style=\"width:24px;\"> **[Fillet](Part_Fillet.md)** which opens the *task panel* for fillets in the [combo view](Combo_view.md) to the side. Change the *radius* spinbox to 20 mm, then in the 3D view, select the width edge to the upper right and click **OK**.\n\n  \n\nThe *task panel* closes and you are back to the Tree view which now has a fillet object instead of the earlier cube.\n\n### Visibility of children \n\nClick the plus sign/caret to expand the children of the fillet, which in this case is the *cube* we created earlier, but it is grayed out. Select the cube and press the space bar -- this toggles visibility so the cube is now visible again and the icon is no longer grayed out. To deselect the cube click in a blank area in the Tree view or the 3D view.\n\n  \n\n### Create the chamfer \n\nNext is to create the 30 degree *chamfer*, start by toggling the visibility of the child cube of the fillet. There is a chamfer tool in [Part Workbench](Part_Workbench.md), but instead of using it we will make the chamfer with another block and a boolean cut.\n\nCreate a new <img alt=\"\" src=images/Part_Box.svg style=\"width:24px;\"> **[Box](Part_Box.md)** with dimensions 60 x 30 x 30. Change the **placement angle** to -30 degrees.\n\n  \n\nThe placement angle is using the **placement vector** (Axis) as axis of rotation. The default is the z-axis, which is not matching our target direction, changing the placement vector to the **y-axis** produces the desired orientation of the cutting tool for the chamfer.\n\n  \n\nThe same placement can be attained with other values as well, the simplest alternative example of a placement that is the same is an angle of +30 degrees and a y-axis of -1.\n\n#### Python console \n\nFurthermore the position needs to be adjusted, looking at the drawing of the finished part, there is no direct dimension to use for the intended translation upwards. Since the upward dimension is the one needed, we have to calculate it. Let's make use of the built in **[Python console](Python_console.md)** for those calculations, it is basic trigonometry. If the FreeCAD Python console is not visible for you, just right-click in an empty space in the toolbar area and check the *Python console* and it should appear in the workspace, when there you should as well add the **[report view](Report_view.md)** if not already visible. The *report view* most of the times provides useful information or even hints of what to do next for different commands.\n\n  \n\nAfter importing the **[math](https://docs.python.org/3/library/math.html#module-math)** module from the standard libraries in python we can use the formula *(50 - math.tan(math.radians(30)) \\* 50)* to find the distance in z-direction that the block should be moved. Copy the result of the formula from the Python console and paste it into the z position for **Cube001**. The *tool* to use for the chamfer *cut* is now properly oriented and positioned.\n\n  \n\n#### Expressions\n\nOne does not have to use the Python console to do the calculation, In most cases when dealing with numeric parametric values, FreeCAD has a short-cut to a built-in calculator. It is called **[Expressions](Expressions.md)** in FreeCAD, you can enter the *expression mode* by first clicking in the spinbox for the z-position, a small blueish circular icon will appear at the right side.\n\n  \n\nClicking that icon opens new window *Formula editor* where formulas and expressions can be entered as shown below. Using expressions is a powerful tool, since one can access parameters from the model, effectively making all parameters in the model available as variables to be used when creating an expression. In short, in our formula, instead of entering the number 50 when in the formula editor, we could enter a *named parameter* holding the value 50 from the cube, with the benefit that if we change the cube *height*, the position of the chamfer will automatically follow. The value of 50 in the current model is referred to as *Cube.Length*, i.e. the *Length* property of the *Cube* feature. Further information on this can be found on the wiki.\n\n  \n\nTo make the cut, with the **Ctrl** key pressed down first select the **Fillet** in the Tree view and then the latest created cube (named **Cube001**) and finally in the toolbar press the <img alt=\"\" src=images/Part_Cut.svg style=\"width:24px;\"> **[Cut](Part_Cut.md)** button. Your Tree view should now again be a single object in the root called **Cut**.\n\n  \n\n#### The toolbars \n\nA sidenote on the toolbars, since they are the typical avenue to invoke commands. Although there is a basic setting for the layout of the toolbars, the actual layout on your computer could turn out to be less than ideal. In such cases it is easy to adjust. Consider the upper section of the below image. There are two rows of toolbars and only a limited number of the [Part Workbench](Part_Workbench.md) toolbar buttons are visible. The simplest way to see more toolbar buttons is to maximize the FreeCAD window, unless it already is maximized of course.\n\nMore common is to adjust the layout of the toolbars to suit your needs and your specific computer. The repositioning is done with the handle on the left of each toolbar. You can just click and drag the handle to a new location. In the lower section of the below image the toolbar positions have been adjusted, revealing their full content. Changes to toolbar positions are persistent through sessions.\n\n  \n\n#### The measurement tool \n\nThe **[measurement tool](Part_Workbench#Measure.md)** in the **Part Workbench** can be used to check that our calculation and placement of the chamfer is correct. Press the <img alt=\"\" src=images/Part_Measure_Linear.svg style=\"width:24px;\"> **[Measure Linear](Part_Measure_Linear.md)** button and a *task panel* opens up, then select the 2 endpoints of one side of the chamfer.\n\n  \n\nIt checks out with an x dimension of 50 mm, clear the measurement and close the dialogue.\n\n### Create the hole \n\nTo make the hole, press the <img alt=\"\" src=images/Part_Cylinder.svg style=\"width:24px;\"> **[Cylinder](Part_Cylinder.md)** button, set the *radius* to 5 mm and *height* to 50 mm.\n\n  \n\nNext we need to position the hole according to the dimensions in the drawing. Change the view to <img alt=\"\" src=images/Std_ViewTop.svg style=\"width:24px;\"> **[Top](Std_ViewTop.md)** view, then right-click the **Cylinder** in the Tree view and select **Transform** from the pop-up menu.\n\n  \n\nChange the *Translation increment* to 5 and use the red and green arrow to position the cylinder in the right position, moving it 15 mm in y and 65 in x by dragging the arrow ends with the mouse. Click **OK** to close the *Transform* dialogue. To make the hole press the **Ctrl** key and select the **Cut** and **Cylinder** in the Tree view, then press the <img alt=\"\" src=images/Part_Cut.svg style=\"width:24px;\"> **[Cut](Part_Cut.md)** button in the toolbar. Your Tree view should once again have a single object in the root called **Cut001**.\n\nCongratulations, the model is now ready.\n\n  \n\nWith the basic model ready, let us explore different ways to alter this model, some examples are related to the appearance, additional features, or simply a different way to do the same.\n\n## Changing the color and transparency \n\nThere are several different ways one can change the appearance of objects, for this case, let\\'s use the view tab in the property part of the combo view. First select the object in the Tree view and then edit any property like line color, shape color or transparency via the **view tab** (found at the bottom of the *combo view*).\n\n  \n\nUnfortunately when the object is selected it is a bit hard to see how it will look when tuning the new appearance. To see the final result one has to deselect the object. Here is the new look of the model, where one now can see the through hole also in the iso-view. Another way to edit the appearance is via the **View → _Appearance...** menu.\n\n  \n\n## A different way to locate the hole \n\nDo a *save-as* under a new name. Then delete the cut that added the hole and move the cylinder back to zero position. Your model should look like the below picture, which is the starting point for using a different technique to locate the hole at the center of the upper face. Note that the color is back to the default gray, the change in appearance we did was on the cut object which now is deleted.\n\n  \n\nThis time the <img alt=\"\" src=images/Workbench_Draft.svg style=\"width:24px;\"> **[Draft Workbench](Draft_Workbench.md)** will be used to locate the hole. The hole is as before to be located at the center of the upper face, which is the same as the midpoint of the diagonal of the upper face.\n\nStart by switching the workbench to **Draft**, it might be that a *grid* appears in the 3D view, the grid visibility can be toggled with <img alt=\"\" src=images/Draft_ToggleGrid.svg style=\"width:24px;\"> [Toggle Grid](Draft_ToggleGrid.md) in the toolbar. When making use of the **[snap](Draft_Snap.md)** functionality in the **Draft Workbench** it helps to only have the *snap types* of interest enabled. This time it is sufficient to leave *endpoint, midpoint and circle center enabled*, so the settings for snapping should look something like below.\n\n  \n\nFinding the point to place the center of the cylinder could be done by making a diagonal as helpline and use the center of the cylinder and midpoint of the diagonal to identify the points to move between, however it turns out that we do not even need to make any helplines, we can snap on already existing solid geometry.\n\nSelect the **Cylinder** in the Tree view (it turns green in the 3D view) and press the <img alt=\"\" src=images/Draft_Move.svg style=\"width:24px;\"> **[Move](Draft_Move.md)** button in the toolbar. A *task panel* opens for moving objects, make sure that *Copy* is unchecked.\n\n  \n\nThen move the mouse to the upper face of the cylinder so that you see a *white dot* in the center of the circle as per the left picture below, this together with the center symbol next to the mouse pointer means that a left button mouse click will snap to the white point.\n\n  \n\nWhen you have the white dot on the upper face, click the left mouse button, and repeat for the upper square face of the main solid, like the right picture above, and confirm the choice with a left mouse button click. The snap function makes use of *mass-center* for any type of face, and in this case the mass center is the same as the geometrical center that is sought after. You will by now have noticed that the move of the cylinder is animated, so you always see what is about to happen.\n\nRepeating the step of the **boolean cut** from earlier once again will make the through hole that completes the model. Using the **linear measurement tool** in the Part Workbench, a check that the hole is correctly placed is done. The measurement can only be done between *points*, so the measurement is done from main body zero to the seam point of the cylinder, meaning that the correct distance is 70 mm instead of the 65 that is on the drawing to account for the extra radius that is included in the distance.\n\n  \n\n## Making the hole a countersunk hole \n\nSwitch back to the [Part Workbench](Part_Workbench.md) and create a *cone* by pressing the <img alt=\"\" src=images/Part_Cone.svg style=\"width:24px;\"> **[Cone](Part_Cone.md)** button in the toolbar. Change *radius1* to 0 mm and *radius2* to 7 mm -- this will give a 2 mm *countersink* on the radius. Making the *height* of the cone 7 mm results in a 90 degree top angle of the cone, or 45 degree countersink angle. Worth to note is that again one could as well use the <img alt=\"\" src=images/Part_Chamfer.svg style=\"width:24px;\"> [Chamfer](Part_Chamfer.md) operation.\n\nWhen working with FreeCAD you will continuously be faced with several different ways to achieve seemingly the same result. There is hardly any absolute truth in what is the right way to achieve a particular end result -- however when looking in a specific context one specific workflow can be more flexible, allow for later features to actually be used etc. How you build 3D models will evolve over time as you along the way learn more and more about the features and capabilities of FreeCAD.\n\n  \n\nTranslate the cone so that it is *concentric* with the hole and *coplanar* with the main solid upper surface. Use any method described earlier in this tutorial to accomplish that.\n\nIn the picture below the move is made with *Transform* and an *increment* setting of 1 mm, since the cone has a characteristic dimension of 7 mm, meaning that the earlier increment setting of 5 mm will not allow for correct positioning. The <img alt=\"\" src=images/Std_DrawStyleWireFrame.svg style=\"width:24px;\"> **[Wireframe](Std_DrawStyle#Wireframe.md)** rendering is used to easier see that the cone is in the right position.\n\n  \n\nTo complete the model, let\\'s make use of the <img alt=\"\" src=images/Part_Boolean.svg style=\"width:24px;\"> **[Boolean](Part_Boolean.md)** command instead of first selecting objects and apply a specific boolean operation. Press the toolbar button and a *task panel* opens as per the below picture to the left.\n\n  \n\nThree items needs to be specified, the *operation type*, the *first shape* and the *second shape*. The cone is supposed to be cut, this is called *Difference* in this command, instead of *Cut*. The first shape is our **Cut001**, it is listed under *compounds*, since it is build from several solids. The second shape is the **Cone**. Once the correct settings are made for the command, click the **Apply** button to execute the operation. This has all been done in the picture to the right, and there one can also see that a *compound* **Cut002** is now listed, this is our final model shape. After having changed the appearance the final model looks like this.\n\n  \n\n## Making a hollow piece \n\nDo a *save-as* under a new name. FreeCAD has all of the typical operations of a 3D modeller, one of them is <img alt=\"\" src=images/Part_Thickness.svg style=\"width:24px;\"> **[Thickness](Part_Thickness.md)**, which is used to *hollow out* parts.\n\nRotate the view so that the bottom face of the model is visible.\n\n  \n\nSelect the *bottom face* of the model, then in the [Part Workbench](Part_Workbench.md) select <img alt=\"\" src=images/Part_Thickness.svg style=\"width:24px;\"> **[Thickness](Part_Thickness.md)** and the screen should look like below.\n\n  \n\nClick **OK**, as you can see there is now a *radius* on the hollowed out part.\n\n  \n\nMoreover, when taking a measurement of the width of the part, it is now 32 mm, so the *thickness* has been applied *outwards*. Let's edit that, double-click the model in the Tree view and modify the *join-type* settings to *intersection* and the *thickness* setting to -1.\n\n  \n\nNow the outer width of the part is 30 mm, same as before and the corners are all sharp corners.\n\n  \n\n## A different way to position the chamfer \n\nDo a *save-as* under a new name. Then delete features so that the model looks like below.\n\n  \n\nMake a **Cube** with dimensions **30x30x60**, ending up like below.\n\n  \n\nChange the **placement** by first rotating -120 degrees around the Y-axis.\n\n  \n\nFinally, change the position to **X=50** and **Z=50** and make the *cut* to produce the same result as earlier.\n\n  \n\nThis once again highlights that there are always several ways to produce the same outcome, which is a recurring theme when it comes to 3D modeling. When it comes to basic geometries or solids, one can use different workbenches in FreeCAD as well as different commands and still have the same outer shape of a solid. You simply need to find your own way to a set of preferred tools and workflow that you are comfortable in using. Modeling in parametric 3D is a process of constant learning, and takes practice to master.\n\n## Editing dimensions, face colors and TNP \n\nFreeCAD is a parametric 3D modeler, this allows you to change any *placement* or *dimension* and the model will update accordingly. In general this works, but it is possible to break a model when edited -- for example when a fillet is based on an edge that no longer exists due to editing. When a model breaks during editing, it is referred to as **TNP, [Topological Naming Problem](Topological_naming_problem.md)**.\n\nGo ahead and experiment with changing dimensions and placements to see if you can break the model, do not forget to recalculate the model after changes if required. This can be done with the <img alt=\"\" src=images/Std_Refresh.svg style=\"width:24px;\"> [Refresh](Std_Refresh.md) button in the toolbar, if the icon is grayed out it is not needed to refresh the object.\n\n### Reposition the cylinder \n\nHere is an example of the cylinder moved from the center to one side of the main body by using *Transform* on the cylinder. As can be seen in the picture, the cone is still in the original position, not affected by the move of the cylinder.\n\n  \n\nWhen you move the cylinder and break through the outer surface, in version 0.19 you are loosing part of the color settings on your model. FreeCAD reverts to the user default settings for shape colors and transparency in the 3D view, however the **Cut002** shape still shows the colors and transparency that it had before as seen in below picture.\n\n### Fixing the colors \n\n  \n\nHere is one way to get it back. First change *transparency* one tick up or down and then back, that brings back the transparency. You can do the same trick on *shape color*. Another way to get the color back is to *right-click* **Cut002** in the Tree view and select **Set Colors** in the context menu. In the *task panel* that displays, click **Set to Default**, that brings back the color to the one set in the view-properties.\n\n  \n\nThe **Set Colors** command allows you to select individual faces of a shape and set a unique color on the selected faces.\n\n### Multiple solids \n\nAnother example where the cube that is making the chamfer has been translated and rotated.\n\n  \n\nAs can be seen when repositioning the chamfer in this way, the end result is *3 disjoint solids*. [Part Workbench](Part_Workbench.md) allows this, [PartDesign Workbench](PartDesign_Workbench.md) does not, either you will get an *multiple solids error* or it will simply not render all solids.\n\n### TNP\n\nGoing back to the original completed model, let's explore how the faces are named.\n\nHere the **[selection view](Selection_view.md)** has been made active, just to show clearly what is selected and not, also coloring is adjusted so that the selection is easier to see.\n\n  \n\nSelecting one side face and the cylinder inner face gives that they are internally called face *2* and *9*, where face *2* is the side face. Face numbering can be different for you.\n\nMoving the cylinder so that the cavity ends up on the side face, and doing the selection of faces now gives a different number for the cylindrical face.\n\n  \n\nFace 2 is the right side of the original face 2, the left side of former face 2 is now face 8. The cylindrical part was face 9, but is now face 7. FreeCAD reassigns the numbering and the order is not necessarily preserved. The total face count in the first model is 10, in the version with the cylindrical face piercing the side face, the total face count is 11. So obviously face numbering has to change when the so called *topology* changes. This probably feels like a minute detail, but turns out to be quite important in parametric 3D CAD. Imagine that you have used the cylindrical face as reference for another feature, it used to be called face 9, but is now called face 8. The reference to the intended cylindrical surface is lost. Since FreeCAD, at least in currently released versions does not keep track of the *intended face*, it only keeps track of the *numbered face*, a model breaks when a reference is made to a face that later is renumbered. This is called **TNP, [Topological Naming Problem](Topological_naming_problem.md)**.\n\nYou are encouraged to learn how to avoid broken models due to TNP, further reading can be done [elsewhere on the wiki](Topological_naming_problem.md), which largely focuses on a *sketch driven* workflow, the underlying mechanism is the same though. The renumbering described here for faces goes for all geometrical entities, faces, edges and vertexes.\n\n## Organizing the tree a bit differently \n\nDo a *save-as* under a new name. Then delete all the cuts ending up with a model looking like below.\n\n  \n\nWhen using the **Part Workbench** and modelling feature rich solids, the tree structure of a solid can become hard to decipher. So far we have created one primitive / feature and applied a boolean operation. In the Part Workbench one can bundle primitives into one boolean operation. In our case we have the cylinder, cone and cube that are all a cut boolean operation.\n\nInstead of making a cut for each primitive, we can first apply a boolean union, <img alt=\"\" src=images/Part_Fuse.svg style=\"width:24px;\"> **[Fuse](Part_Fuse.md)** the primitives intended for the boolean cut, and then make the *cut* between the **Fillet** and the **Fusion**.\n\nUsing this approach, the Tree view ends up looking like below, which is just a different way of building the same model. Compare this with the original Tree view, none is better than the other, however when making more complex models, one approach over the other can have benefits in ease of modifying/reorganizing the model if needed.\n\n  \n\n## Wrapping up \n\nHaving gone through the tutorial you are now briefly acquainted with the user interface of FreeCAD and you have learned the basics in using the **Part Workbench**. You should now be able to build simple models after your own liking. The **Part Workbench** is one of the workbenches that can be used to create solids, the **PartDesign Workbench** is another. The different workbenches have different capabilities and workflows. Learning FreeCAD in full, especially considering all add-ons and macros takes years, so keep on exploring new and different ways of making models -- take different tutorials on the wiki, the learning never stops when working with FreeCAD. It is suggested that you learn *sketches* and the **PartDesign Workbench** next if your focus is on creating solids. If your focus is modelling buildings your next learning should be the **Draft** and **Arch** workbenches.\n\nAt last, FreeCAD is made by volunteers in their spare time. If you want to further advance FreeCAD's capabilities, consider [contributing](Help_FreeCAD.md) to FreeCAD, for example by improving the documentation.\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Category_Part.md) > Creating a simple part with Part WB\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 7071, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Dodo_Workbench.md", "text": "# Dodo Workbench\n1. REDIRECT [Flamingo Workbench](Flamingo_Workbench.md)Dodo is a Py3/Qt5 update of Flamingo with some other revisions a refactoring\n\n\n---\n⏵ [documentation index](../README.md) > Dodo Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 65, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Draft_Pattern.md", "text": "# Draft Pattern\n## Description\n\n[Draft](Draft_Workbench.md) objects with a **Make Face** property can display an SVG pattern instead of a solid face color.\n\n  \n*An ellipse and a polygon with an SVG pattern*\n\n## Usage\n\n1. Make sure the objects are closed and planar, and do not self-intersect.\n2. To close a [Draft Wire](Draft_Wire.md), a [Draft BSpline](Draft_BSpline.md), a [Draft CubicBezCurve](Draft_CubicBezCurve.md) or a [Draft BezCurve](Draft_BezCurve.md) set its **Closed** property to `True`.\n3. To close a [Draft Circle](Draft_Circle.md) or a [Draft Ellipse](Draft_Ellipse.md) set its **First Angle** and **Last Angle** properties to the same value.\n4. Select the objects.\n5. Switch to the **View** tab of the [Property editor](Property_editor.md).\n6. The **Display Mode** must be set to {{Value|Flat Lines}}.\n7. Select a **Pattern**.\n8. Optionally change the **Pattern Size**. Note that a higher value results in a denser pattern.\n9. The pattern is not displayed when the objects are selected. Deselect them to check the result.\n10. Optionally reselect the objects to change the pattern properties.\n\n## Available patterns \n\n\nImage:Aluminium.svg\\|aluminium Image:Brick01.svg\\|brick01 Image:Concrete.svg\\|concrete Image:Cross.svg\\|cross Image:Cuprous.svg\\|cuprous Image:Diagonal1.svg\\|diagonal1 Image:Diagonal2.svg\\|diagonal2 Image:Earth.svg\\|earth Image:General_steel.svg\\|general_steel Image:Glass.svg\\|glass Image:Hatch45L.svg\\|hatch45L Image:Hatch45R.svg\\|hatch45R Image:Hbone.svg\\|hbone Image:Line.svg\\|line Image:Plastic.svg\\|plastic Image:Plus.svg\\|plus Image:Simple.svg\\|simple Image:Solid.svg\\|solid Image:Square.svg\\|square Image:Steel.svg\\|steel Image:Titanium.svg\\|titanium Image:Wood.svg\\|wood Image:Woodgrain.svg\\|woodgrain Image:Zinc.svg\\|zinc\n\n\n## Notes\n\n- SVG patterns are stored in **.SVG** files. It is possible to use your own custom patterns. See [Preferences](#Preferences.md).\n- The patterns themselves are not saved in the FreeCAD document. Objects whose **Pattern** cannot be found are displayed with a solid face color instead.\n\n## Preferences\n\nSee also: [Preferences Editor](Preferences_Editor.md) and [Draft Preferences](Draft_Preferences.md).\n\n- To change the **Pattern Size** used for new objects: **Edit → Preferences... → Draft → Visual → SVG pattern size**.\n- To specify a directory with addition SVG patterns: **Edit → Preferences... → Draft → Visual → Additional SVG pattern location**.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Pattern\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 689, "license": "CC0-1.0", "author": "Open-source contributors"}
|