{"id": "freecad-docs:wiki/3D_view.md", "text": "# 3D view\n## Introduction\n\n \n\nThe [3D view](3D_view.md) of FreeCAD is an instance of a Coin3D [scenegraph](Scenegraph.md) that forms the most important window in the [interface](interface.md). Coin3D is a library that implements the OpenInventor 2.1 scene description standard.\n\nCertain properties of the view, like background color, [mouse navigation](Mouse_navigation.md) style, and zooming steps, can be configured in the [preferences editor](Preferences_Editor.md).\n\n
\n\n\n*The [Draft Workbench](3D_view]]_is_a_component_of_the_FreeCAD_[[interface]]. By default it shows a small widget with coordinate axes, and the navigation cube also with coordinate axes; the grid can be displayed and configured by loading the [[Draft Workbench.md).*\n\n## Context menu \n\nThe options in the context menu of the 3D view depend on the selected object(s) and the currently active workbench. To display this menu optionally select one or more objects and then right-click in the 3D view.\n\n## Details\n\nFreeCAD uses the Quarter library to use Coin3D in a Qt environment.\n\nIt is possible to interact directly with the 3D view scenegraph from the [Python console](Python_console.md) by using the Python library Pivy.\n\nFor more information see the power user documentation:\n\n- [Scenegraph](Scenegraph.md), description of Coin3D.\n- [Pivy](Pivy.md), usage of Coin3D from the Python console.\n- [Third party libraries](Third_Party_Libraries.md) used by FreeCAD.\n- [Coin3D](https://grey.colorado.edu/coin3d/index.html) C++ documentation.\n\n {{Interface navi}}\n\n\n---\n⏵ [documentation index](../README.md) > 3D view\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 416, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/API_documentation.md", "text": "# API documentation\n1. REDIRECT [:Category:API](:Category_API.md)\n\n\n---\n⏵ [documentation index](../README.md) > [API](Category_API.md) > API documentation\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 43, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Advanced_FreeCAD_test_system.md", "text": "# Advanced FreeCAD test system\nThis page is dedicated to the Google Summer of Code project regarding the enhancement of FreeCAD\\'s test system.\n\n**Obsolete**: This page has been moved to \n\n## Outline\n\nFreeCAD as a CAE application has a high level of complexity, both in its source code and also in its user interaction. To ensure a certain level of quality automatic testing is essential. However, as an open source application with spare time coders only this part of the project has not seen very much attention. One of the major reasons is the low-level handling required to write test cases. All actions to trigger, every result fetching and every single comparison needs to be hand coded. This makes it cumbersome to provide a test for every created functionality and possibly impossible to do so if deep document comparisons are needed. For example the Part and PartDesign workbench: An automated test for document objects require the resulting topology shape to be analysed. This is a tremendous part and cannot be handled on a per test basis.\n\nThis project aims at reducing the work required to write meaningful tests. This should be accomplished by providing a infrastructure for result file storage and special \\\"comparators\\\" which compare the stored result files with the test result for equality.\n\n## Details\n\n1. Create a result file infrastructure for the test system. It should allow to save an arbitrary number of files together with the test itself where the expected results are stored. It is intended to have one result file for each comparator used. The infrastructure should make the storage (file structure), loading and handling easy. It furthermore should define a specification for the generic file content, e.g. which comparator to use for it etc.\n2. Create a infrastructure for comparators and provide a few important ones. The comparators should be able to read in a result file and compare the available test output with it. As every workbench requires different types of comparisons the comparators need to be provided by the workbench itself, as well as possible top-level ones. The test infrastructure needs to be adopted to work with such workbench specific types. Furthermore there needs to be a way to generate result files for comparators. this can be done either by themselves or by a different class.\n 1. Implement a global comparator for the document structure: It stores the Document object structure with all properties in a result file and compares the available document after a test run with it\n 2. Implement a Part workbench comparator for shapes: It stores data about a certain TopoShape in a result file suitable for comparison, e.g. number of edges/vertices/faces, properties like area, mass, center of gravity.\n 3. Advanced: Create a global comparator for the 3D output based on picture comparison. This is marked as advanced as this comparator needs to be tolerant to slight changes due to driver differences (see VTK for example) and also needs to somehow ensure the same display settings used for the comparators every time\n3. Create a wizard or GUI for test creation in the Test workbench. This would work like macro recording: the user starts the test recording, and everything plotted in the python console would be the test procedure. When hitting stop the user gets a dialog where he can choose which comparators to apply. The wizard than creates the appropriate test structure with the test itself, all needed result files etc.\n4. Create a Wiki page describing the working of the test system and how to create tests and new comparators\n\n## Expected Outcome \n\n1. Mergable code for a result file based comparator system\n2. A GUI for simplified test generation based on macro recording\n3. A Wiki page describing the procedure for the user to create tests and the developer to create new comparators\n4. Tests which utilize the created comparators and show their use\n\n## Future Possibilities \n\nFuture contributions can include new comparators, e.g. for meshes. Also creating tests for existing functionality has a high priority and can be achieved with the new system. Futhermore a GUI based system can be created, where a test is defined by recorded UI events, see [Record and replay events](http://algoholic.eu/recording-and-replaying-qt-input-events/). This could also be a new GSoC project.\n\n## Project Properties \n\n### Skills\n\n- Programming language mainly Python, some comparators may need C++ code.\n- Understand and use APIs from FreeCAD and external libraries (OCC for Part comparator)\n\n### Difficulty\n\nMedium\n\n### Project size \n\n175h\n\n### Additional Information\n\n\n---\n⏵ [documentation index](../README.md) > Advanced FreeCAD test system\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 970, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/App_GeoFeature.md", "text": "# App GeoFeature\n## Introduction\n\n
\n\nAn [App GeoFeature](App_GeoFeature.md) object, or formally an `App::GeoFeature`, is the base class of most objects that will display geometrical elements in the [3D view](3D_view.md) because it includes a **Placement** property.\n\n
\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nThe [App GeoFeature](App_GeoFeature.md) is an internal object, so it cannot be created from the graphical interface. It is generally not meant to be used directly, rather it can be sub-classed to get a bare-bones object that only has a basic **Placement** property to define its position in the [3D view](3D_view.md).\n\nSome of the most important derived objects are the following:\n\n- The [Part Feature](Part_Feature.md) class, the parent of most objects with 2D and 3D [topological shapes](Part_TopoShape.md).\n- The [Mesh Feature](Mesh_Feature.md) class, the parent of most objects made from [meshes](Mesh_MeshObject.md), not solids.\n- The [Fem FemMeshObject](FEM_Mesh.md) class, the parent of finite element meshes created with the [FEM Workbench](FEM_Workbench.md).\n- The [CAM Feature](CAM_Feature.md) class, the parent of paths created with the [CAM Workbench](CAM_Workbench.md) for use in CNC machining.\n- The [App Part](App_Part.md) class, which defines [Std Parts](Std_Part.md) that can be used as containers of bodies to perform assemblies.\n\nWhen creating this object in [Python](Python.md), instead of sub-classing `App::GeoFeature`, you should sub-class `App::GeometryPython` because the latter includes a default view provider, and `Proxy` attributes for the object itself, and its view provider. See [Scripting](App_GeoFeature#Scripting.md).\n\n## Properties App GeoFeature \n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThe [App GeoFeature](App_GeoFeature.md) (`App::GeoFeature` class) is derived from the basic [App DocumentObject](App_DocumentObject.md) (`App::DocumentObject` class) and inherits all its properties. In addition it has a **Placement** property, which controls its position in the [3D view](3D_view.md).\n\n## Properties App GeometryPython \n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThe [App GeometryPython](App_GeoFeature.md) (`App::GeometryPython` class) is derived from the basic [App GeoFeature](App_GeoFeature.md) (`App::GeoFeature` class) and inherits all its properties. It also has several additional properties.\n\nThese are the properties available in the [property editor](Property_editor.md). Hidden properties can be shown by using the **Show all** command in the context menu of the [property editor](Property_editor.md).\n\n### Data\n\n\n{{TitleProperty|Base}}\n\n- **Proxy|PythonObject|Hidden**: a custom class associated with this object.\n\n- **Placement|Placement**: the position of the object in the [3D view](3D_view.md). The placement is defined by a `Base` point (vector), and a `Rotation` (axis and angle). See [Placement](Placement.md).\n\n - \n **Angle**\n \n : the angle of rotation around the **Axis**. By default, it is {{value|0°}} (zero degrees).\n\n - \n **Axis**\n \n : the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between {{value|0}} and {{value|1}}. If any value is above {{value|1}}, the vector is normalized so that the magnitude of the vector is {{value|1}}. By default, it is the positive Z axis, {{value|(0, 0, 1)}}.\n\n - \n **Position**\n \n : a vector with the 3D coordinates of the base point. By default, it is the origin {{value|(0, 0, 0)}}.\n\n- **Label|String**: the user editable name of this object, it is an arbitrary UTF8 string.\n\n- **Label2|String|Hidden**: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|\"\"}}.\n\n- **Expression Engine|ExpressionEngine|Hidden**: a list of expressions. By default, it is empty {{value|[]}}.\n\n- **Visibility|Bool|Hidden**: whether to display the object or not.\n\n### View\n\n\n{{TitleProperty|Base}}\n\n- **Proxy|PythonObject|Hidden**: a custom [viewprovider](Viewprovider.md) class associated with this object.\n\n\n{{TitleProperty|Display Options}}\n\n- **Bounding Box|Bool**: if it is `True`, the object will show the bounding box in the [3D view](3D_view.md).\n\n- **Display Mode|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Show In Tree|Bool**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Visibility|Bool**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n\n{{TitleProperty|Object Style}}\n\n- **Shape Color|Color**: a tuple of three floating point RGB values light gray .\n\n- **Shape Material|Material|Hidden**: an [App Material](App_Material.md) associated with this object. By default it is empty.\n\n- **Transparency|Percent**: an integer from {{value|0}} to {{value|100}} that determines the level of transparency of the faces in the [3D view](3D_view.md). A value of {{value|100}} indicates completely invisible faces; the faces are invisible but they can still be picked as long as **Selectable** is `True`.\n\n\n{{TitleProperty|Selection}}\n\n- **On Top When Selected|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Selectable|Bool**: if it is `True`, the object can be picked with the pointer in the [3D view](3D_view.md). Otherwise, the object cannot be selected until this option is set to `True`.\n\n- **Selection Style|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n## Scripting\n\n\n**See also:**\n\n[FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md) and [scripted objects](Scripted_objects.md).\n\nSee [Part Feature](Part_Feature.md) for the general information on adding objects to the document.\n\nA GeoFeature is created with the `addObject()` method of the document. If you would like to create an object with a 2D or 3D [topological shape](Part_TopoShape.md), it may be better to create one of the sub-classes specialized for handling shapes, for example [Part Feature](Part_Feature.md) or [Part Part2DObject](Part_Part2DObject.md).\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::GeoFeature\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\nFor [Python](Python.md) subclassing you should create the `App::GeometryPython` object.\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::GeometryPython\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\n\n---\n⏵ [documentation index](../README.md) > App GeoFeature\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1693, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_3DS.md", "text": "# Arch 3DS\n## Description\n\nThe BIM Workbench supports importing [3DS](https://en.wikipedia.org/wiki/.3ds) files. The 3DS format is ancient but still widely used on the internet. It can contain mesh data and material information. At the moment, it will import mesh objects contained in the file as FreeCAD mesh objects, and has no support for materials yet.\n\n\n---\n⏵ [documentation index](../README.md) > [File Formats](Category_File%20Formats.md) > [BIM](Category_BIM.md) > Arch 3DS\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 123, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Arch_CutLine.md", "text": "---\n GuiCommand:\n Name: Arch CutLine\n MenuLocation: Arch , Cut with line\n Workbenches: Arch_Workbench\n Version: 0.19\n SeeAlso: Arch_CutPlane\n---\n\n# Arch CutLine\n\n## Description\n\nThe **Arch CutLine** tool cuts a solid Arch object like an [Arch Wall](Arch_Wall.md) or [Arch Structure](Arch_Structure.md) with a straight edge. Based on that edge and the normal of the [Draft working plane](Draft_SelectPlane.md) a cutting face is generated.\n\n
\n\n\n*[Arch Wall](Arch_Wall.md) cut by a line. Left: subtractive box that appears when using the tool. Right: resulting wall after the cut is done.*\n\n## Usage\n\n1. If required align the working plane:\n - The selected edge may not be parallel to the normal of the working plane.\n - The generated cutting face will be perpendicular to the working plane.\n2. Select the object to be cut in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n3. Select a straight edge. This must be selected in the [3D view](3D_view.md).\n4. Press the **
[Cut with line](Arch_CutLine.md)** button.\n5. Choose **Behind** or **Front** to indicate on which side of the cutting face material should be removed.\n6. Press the **OK** button.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch CutLine\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 441, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Artwork_Plot.md", "text": "# Artwork Plot\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## Mod/Plot/\n\n### Mod/Plot/freecad/plot/resources/icons/\n\n
\n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Plot](Category_Plot.md) > Artwork Plot\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 266, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_AxialMove.md", "text": "---\n GuiCommand:\n Name: Assembly3 AxialMove\n Icon: Assembly_AxialMove.svg\n MenuLocation: Assembly3 , Axial move part\n Workbenches: Assembly3_Workbench\n Shortcut: **A** then **A**\n---\n\n# Assembly3 AxialMove\n\n## Description\n\nThe
[Axial move](Assembly3_AxialMove.md) command provides a tool to move a part within an assembly context. It consists of 3 arcs with spherical handles to rotate the part and 3 arrow handles to move the part without rotation which represent the selected object\\'s implicit coordinate system (ICS).\n\n
\n\n## Usage\n\n1. Select either a face, an edge, or a vertex of the 3D part or the whole part in the assembly tree.\n2. Activate the
**Axial move** command using one of the following:\n - The **
[Axial move part](Assembly3_AxialMove.md)** button.\n - The **Assembly3 →
Axial move part** menu option.\n - The keyboard shortcut: **A** then **A**.\n3. Drag the handles to reposition the part.\n4. To fix the position and leave the tool use one of the following:\n - The **Esc** key.\n - The **OK** button in the Tasks panel.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 AxialMove\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 406, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_ConstraintEqualAngle.md", "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintEqualAngle\n Icon: Assembly_ConstraintEqualAngle.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintEqualAngle\n\n## Description\n\nThis tool builds a link between two objects of an assembly and fixes one angle between them in relation to another angle\\'s value. The selected elements of each object or more precisely their implicit coordinate systems (ICS) are used to position one object to another.\n\nIt can handle 3D line elements and planar face elements as well as 2D line elements within a work plane.\n\nThe line directions as well as the face normals are represented by each ICS\\'s z-axis and so it actually fixes the angle between both elements\\' z-axes (on basis of another angle between two z-axes).\n\n## Usage\n\n1. Place two objects into an assembly\n2. Select one line element or one planar face element of each object\n3. Select two more line or one planar face elements to extract the value of the angle between them\n4. Press the **
[Equal angle](Assembly3_ConstraintEqualAngle.md)** button.\n\n: In addition the \\\"Flip element\\\" function of the elements properties panel may be needed if ICSs are not orientated as expected.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintEqualAngle\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 305, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_ConstraintPointsDistance.md", "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintPointsDistance\n Icon: Assembly_ConstraintPointsDistance.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintPointsDistance\n\n## Description\n\nThis tool builds a link between two objects of an assembly and fixes the distance between them and the orientation to each other. The selected elements of each object or more precisely their implicit coordinate systems (ICS) are used to position one object to another.\n\n## Usage\n\n1. Place two objects into an assembly\n2. Select one point element of each object\n3. Press the **
[Points distance](Assembly3_ConstraintPointsDistance.md)** button.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintPointsDistance\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 174, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly3_MovePart.md", "text": "---\n GuiCommand:\n Name: Assembly3 MovePart\n Icon: Assembly_Move.svg\n MenuLocation: Assembly3 , Move part\n Workbenches: Assembly3_Workbench\n Shortcut: **A** then **M**\n---\n\n# Assembly3 MovePart\n\n## Description\n\nThe
[Move part](Assembly3_MovePart.md) command provides a tool to move a part within an assembly context. It consists of 3 rings to rotate the part and 6 handles (crossed double arrows) to move the part without rotation. The rings and handles are positioned and oriented according to the selected object\\'s implicit coordinate system (ICS).\n\n
\n\n## Usage\n\n1. Select either a face, an edge, or a vertex of the 3D part or the whole part in the assembly tree.\n2. Activate the
**Move part** command using one of the following:\n - The **
[Move part](Assembly3_MovePart.md)** button.\n - The **Assembly3 →
Move part** menu option.\n - The keyboard shortcut: **A** then **M**.\n3. Drag the rings and handles to reposition the part.\n4. Press **Esc** to fix the position and leave the tool.\n\n## Notes\n\nThe handles move the part parallel to one of the basic planes of the selected object\\'s ICS; pressing and holding **shift** while dragging limits the movement to one axis.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 MovePart\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 412, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Assembly_SolveAssembly.md", "text": "---\n GuiCommand:\n Name: Assembly SolveAssembly\n MenuLocation: Assembly , Solve Assembly\n Workbenches: Assembly_Workbench\n Shortcut: **Z**\n Version: 1.0\n SeeAlso: \n---\n\n# Assembly SolveAssembly\n\n## Description\n\nThe
[Assembly SolveAssembly](Assembly_SolveAssembly.md) tool solves the currently active Assembly.\n\n## Usage\n\n1. There are several ways to invoke the tool:\n - Press the **
[Solve Assembly](Assembly_SolveAssembly.md)** button.\n - Select the **Assembly →
Solve Assembly** option from the menu.\n - Use the keyboard shortcut: **Z**.\n2. \\...\n\n\n {{Assembly_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Assembly](Assembly_Workbench.md) > Assembly SolveAssembly\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 232, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Box.md", "text": "---\n GuiCommand:\n Name: BIM Box\n MenuLocation: 3D/BIM , Generic 3D tools , Box\n Workbenches: BIM_Workbench\n SeeAlso: Part_Box\n---\n\n# BIM Box\n\n## Description\n\n
\n\nThe **BIM Box** tool allows you to create a standard [Part Box](Part_Box.md), but instead of creating the object and letting you specify its dimensions and position afterwards, like the original [Part Workbench](Part_Workbench.md) tool does, this tool allows you to place and define the box dimensions graphically when creating the object. Boxes are basic [cuboid](https://en.wikipedia.org/wiki/Cuboid) shapes, that can be used as a base of any other kind of BIM object later on.\n\n## Usage\n\n1. Press the **
[Box](BIM_Box.md)** button\n2. Click a first point to define a first corner of the box. It can be any of the box corners\n3. Click a second point to define a first edge of the box, starting from the first point\n4. Click a third point to define a first face of the box, orthogonal to the first edge\n5. Click a fourth point to define the extrusion distance of the first face, forming the final box\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Box\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 340, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Levels.md", "text": "# BIM Levels\n1. REDIRECT [BIM_Views](BIM_Views.md)\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Levels\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 50, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BIM_Material.md", "text": "---\n GuiCommand:\n Name: BIM Material\n MenuLocation: Manage , Material\n Workbenches: BIM_Workbench\n---\n\n# BIM Material\n\n## Description\n\nShows the **BIM material** dialog. The dialog allows to quickly and easily perform material-related operations, with extra focus on efficient working with many objects and many materials.\n\n1. Create new [material](Arch_SetMaterial.md) or [multimaterial](Arch_MultiMaterial.md)\n2. Attribute an existing material or multimaterial to selected object(s).\n\n
\n\n\n*The materials manager*\n\n## Usage\n\n1. (Optionally) select one or more objects\n2. Press the **
[Material](BIM_Material.md)** button in the toolbar.\n\n- If there is no existing material in the active document, the material manager window is not displayed, and a [new material](Arch_SetMaterial.md) will be created.\n- If there is at least one material or multimaterial in the document, the Materials Manager window will open.\n\n## Material manager tools \n\nThe materials manager allows you to:\n\n- **Search materials by name**: Use the search box\n- **Assign a material to the selected object(s)**: Pressing OK with a material selected will assign it to the selected object(s)\n- **Create a [material](Arch_SetMaterial.md)**: Press the **Create new material** button\n- **Create a [multimaterial](Arch_MultiMaterial.md)**: Press the **Create new multi-material** button\n- **Delete a material**: Select a material and right-click a material and choose \\\"Delete\\\"\n- **Delete unused materials**: Press the **Delete unused** button. All materials that are not used by any object will be removed\n- **Merge duplicate materials**: Press the **Merge duplicates** button. Merges the materials with exact same names (ex. Concrete and Concrete) or exact same names with a numeric suffix (ex. Concrete and Concrete001) together\n- **Rename a material**: Right-click a material and choose \\\"Rename\\\"\n- **Duplicate a material**: Right-click a material and choose \\\"Duplicate\\\". This will create a full, independent copy of the chosen material with same settings\n- **Merge two materials together**: Right-click a material and choose \\\"Merge to\\...\\\", then select another material. The first one will be removed, and all objects that were using the first one will be assigned the second one\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Material\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 579, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/BOLTS_Workbench.md", "text": "# BOLTS Workbench\n1. REDIRECT [BOLTSFC Workbench](BOLTSFC_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > BOLTS Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 47, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Branding.md", "text": "# Branding\n## Overview\n\nThis article describes the **Branding** of FreeCAD. Branding means to create your own application based on FreeCAD. That can be only your own executable or [splash screen](Splash_screen.md) till a complete reworked program. On base of the flexible architecture of FreeCAD it\\'s easy to use it as base for your own special purpose program.\n\n## Warning\n\nAlthough FreeCAD is offered to you free of charge, and the FreeCAD community is happy to see other applications emerging, that are based on FreeCAD, we have on the other hand seen a lot of unfair use of the information contained on this page by people who simply rebranded FreeCAD into a closed-source application to make profit from it.\n\nAlthough the [LGPL license](License.md) allows to use the FreeCAD source code in closed-source applications, it also gives strict rules to do so, and does not allow simply taking FreeCAD, renaming it and stripping it of its license.\n\nWould you be interested in using FreeCAD in a closed-source application, be sure to check thoroughly the implications of the LGPL license, and, even better, contact any FreeCAD developer, administrator or moderator before doing so.\n\n## General\n\nMost of the branding is done in the **MainCmd.cpp** or **MainGui.cpp**. These Projects generate the executable files of FreeCAD. To make your own Brand just copy the Main or MainGui projects and give the executable its own name, e.g. **FooApp.exe**. The most important settings for a new look are made in one place in the main() function. Here is the code section that controls the branding:\n\n\n C\nint main( int argc, char ** argv )\n{\n // Name and Version of the Application\n App::Application::Config()[\"ExeName\"] = \"FooApp\";\n App::Application::Config()[\"ExeVersion\"] = \"0.7\";\n\n // set the banner (for loging and console)\n App::Application::Config()[\"CopyrightInfo\"] = sBanner;\n App::Application::Config()[\"AppIcon\"] = \"FooAppIcon\";\n App::Application::Config()[\"SplashScreen\"] = \"FooAppSplasher\";\n App::Application::Config()[\"StartWorkbench\"] = \"Part design\";\n App::Application::Config()[\"HiddenDockWindow\"] = \"Property editor\";\n App::Application::Config()[\"SplashAlignment\" ] = \"Bottom|Left\";\n App::Application::Config()[\"SplashTextColor\" ] = \"#000000\"; // black\n\n // Inits the Application \n App::Application::Config()[\"RunMode\"] = \"Gui\";\n App::Application::init(argc,argv);\n\n Gui::BitmapFactory().addXPM(\"FooAppSplasher\", ( const char** ) splash_screen);\n\n Gui::Application::initApplication();\n Gui::Application::runApplication();\n App::Application::destruct();\n\n return 0;\n}\n\n\nThe first Config entry defines the program name. This is not the executable name, which can be changed by renaming or by compiler settings, but the name that is displayed in the task bar on windows or in the program list on Unix systems.\n\nThe next lines define the Config entries of your FooApp Application. A description of the Config and its entries you find in [Start up and Configuration](Start_up_and_Configuration.md).\n\n## Images\n\nImage resources are compiled into FreeCAD using [Qt\\'s resource system](http://qt-project.org/doc/qt-4.8/resources.html). Therefore you have to write a **.qrc** file, an XML-based file format that lists image files on the disk but also any other kind of resource files. To load the compiled resources inside the application you have to add a line\n\n \n```python\nQ_INIT_RESOURCE(FooApp); \n```\n\ninto the main() function. Alternatively, if you have an image in XPM format you can directly include it into your **main.cpp** and add the following line to register it:\n\n \n```python\nGui::BitmapFactory().addXPM(\"FooAppSplasher\", ( const char** ) splash_screen);\n```\n\n## Branding XML \n\nIn FreeCAD there is also a method supported without writing a customized main() function. For this method you must write a file name called **branding.xml** and put it into the installation directory of FreeCAD. Here is an example with all supported tags:\n\n\n XML\n\n\n FooApp\n Foo App in title bar\n 1\n 0\n 1234\n 2014/1/1\n (c) My copyright\n Foo App URL\n Path to logo (appears in bottom right corner)\n Path to icon file\n Path to program icons\n splashscreen.png\n Bottom|Left\n #ffffff\n #c8c8c8\n PartDesignWorkbench\n\n\n\nAll listed tags are optional.\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Branding\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1176, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_DressupDragKnife.md", "text": "---\n GuiCommand:\n Name: CAM DressupDragKnife\n MenuLocation: CAM , Path Dressup , DragKnife\n Workbenches: CAM_Workbench\n SeeAlso: CAM_DressupTag, CAM_DressupRampEntry, CAM_DressupDogbone\n---\n\n# CAM DressupDragKnife\n\n## Description\n\nThe tool
[DressupDragKnife](CAM_DressupDragKnife.md) uses a cutting edge on a pivot to cut sheet material like vinyl, cardboard, and leather. The cutting point is not aligned with the center of the spindle but rather follows it as the spindle moves. Because the cutting point is offset, the path must be modified to extend past the endpoint of each segment. Also, the dragknife is incapable of making extremely tight turns. To compensate, a pivot \\'corner action\\' is inserted which momentarily lifts the blade slightly and then pivots into the new position.\n\nThis tool dresses up an existing path to add corner actions and edge extensions for drag knife cutting.\n\n## Usage\n\n1. Select a contour or profile path object.\n2. Select the **CAM → Path Dressup →
DragKnife** option from the menu.\n\n## Options\n\n- **Filter Angle** : Determines how acute an angle must be before a corner action is inserted.\n- **Offset** : Input how much the blade point is offset from the spindle center.\n- **Pivot Height** : Determines how high to lift the cutting blade during a corner action. This is material dependent and should be higher for thicker materials. Ideally, the point should remain in the material slightly.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM DressupDragKnife\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 406, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_SimpleCopy.md", "text": "---\n GuiCommand:\n Name: CAM SimpleCopy\n MenuLocation: CAM , Path Modification , Simple Copy\n Workbenches: CAM_Workbench\n SeeAlso: CAM_Copy\n---\n\n# CAM SimpleCopy\n\n## Description\n\nThe tool
[SimpleCopy](CAM_SimpleCopy.md) creates a non-parametric copy of a given path.\n\n## Usage\n\n1. Select one [CAM](CAM_Workbench.md) object\n2. Press the **
[Simple Copy](CAM_SimpleCopy.md)** button\n\n## Options\n\n- The simple copy is not bound anymore to the path that was used to make the copy, and is not parametric. Therefore, when edited with the [CAM Inspect](CAM_Inspect.md) tool, any change made to its G-code will be retained.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM SimpleCopy\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 237, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_Surface.md", "text": "---\n GuiCommand:\n Name: CAM Surface\n MenuLocation: CAM , 3D Surface\n Workbenches: CAM_Workbench\n Version: 0.19\n---\n\n# CAM Surface\n\n## Description\n\nThis tool creates a new
[3D Surface](CAM_Surface.md) operation which is capable of generating G-code paths for the entire top surface of a 3D model (or is able to work with selected faces) and allows for faces to be avoided. This operation offers multiple cut patterns: Line, Zigzag, Circular, Circular Zigzag, Offset, and Spiral (similar to an adaptive pattern). As of version 0.19, this operation offers many customizations to allow for greater productivity.\n\nThe
[3D Surface](CAM_Surface.md) operation is also capable of generating basic rotational 3D surfacing paths. The rotational capabilities are limited to the entire model, and do not allow for specific faces or regions to be isolated. The rotational paths are also limited to line cut patterns.\n\nThe 3D Surface Tool interfaces to OCL.pyd, a 3rd party Open Source module titled [OpenCamLib](OpenCamLib.md), that generates tool paths from a 3D model. OpenCamLib is not integrated directly into FreeCAD.\n\n**Note:** In order to use the 3D Surface operation you must:\n\n1. Properly install [OpenCamLib](OpenCamLib.md).\n2. Enable [Experimental Features](CAM_experimental.md) for the CAM Workbench.\n3. Check **Edit → Preferences... → CAM → Advanced → Enable OCL dependent features**.\n\n## Usage\n\nUsage instructions for multiple variations of the [3D Surface](CAM_Surface.md) operation are presented here.\n\n#### Basic Operation \n\n1. Press the **
[3D Surface](CAM_Surface.md)** icon, or select **CAM → 3D Surface** from the dropdown menu.\n2. Select the tool controller for the Operation from the Tool controller dialogue pop up window, if presented.\n3. In the Base Geometry tab, select any specific faces you wish to focus on and/or avoid for the operation.\n4. Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.\n5. Make adjustments in Heights tab if needed.\n6. Configure settings in the Operations tab as needed:\n - Choose your Coolant Mode.\n - Choose the BoundBox: Stock or BaseBoundBox\n - Set the Scan Type for the operation: Planar or Rotational\n - Select the Layer Mode for the operation: Single-pass or Multi-pass\n 1. Single-pass is for a finishing pass\n 2. Multi-pass could be used for clearing in combination with the use of Depth Offset to leave a thin surface layer for a finish pass\n - Add additional BoundBox Extra Offset to X and Y as desired (*Rotational scans only*)\n - Set the Drop Cutter Direction: X or Y. This is the linear direction the cutter(spindle) will travel. (*Rotational scans only*)\n - Add a Depth Offset value if you wish to leave a specified thickness of material on the surface, for say a final finish pass\n - Set the Sample Interval used for the OCL scan.\n - Set the Step Over value as a percentage of the diameter of the Tool.\n - Check the Use Start Point box if you wish to provide a start point for the operation in the properties view of the data tab for the operation.\n - Boundary Enforcement is enabled by default. This forces the cutter to remain inside the boundaries of the feature geometry for the operation, like a pocketing operation. Disable to allow the cutter to extend to the outside of the feature geometry. The Boundary Adjustment property supersedes this property.\n - Optimize Linear Paths is enabled by default. Disabling will yield a longer gcode result and likely increase cut time.\n7. If you wish to preview the result before accepting the settings, click **Apply**\n8. Click **OK** button to confirm and generate paths.\n\nTo achieve different, or more complex, effects, adjust additional operation properties within the Data tab of the Properties View for the operation.\n\n#### Rotational Scans (4th-axis) \n\n1. Initiate a [Basic Operation](#Basic_Operation.md) as described above and set the **Scan Type** to **Rotational**.\n2. **Note:** Face selection is unavailable for Rotational scans, so changes to Base Geometry are ignored.\n3. Locate the Data tab and Properties View for the new [3D Surface](CAM_Surface.md) operation. A **Rotation** section should be available with additional properties to adjust, listed below.\n It is recommended that you set the desired rotation properties all at once before recomputing. This is done by clicking the ENTER key immediately after changing a property setting. This process will allow you to change and save multiple properties before recomputing the operation.\n4. Adjust the following settings as needed:\n - Set **Cutter Tilt** to the offset index(angle) \\[0-90\\]. (Used for ball mill cutters)\n - Change **Drop Cutter Dir** to the axis of travel for the cutter(spindle).\n - Change **Drop Cutter Extra Offset** to extend the BoundBox in the X and Y directions.\n - Set **Rotation Axis** to the desired axis.\n - Adjust **Start Index** to start index(angle) \\[0-360\\].\n - Adjust **Stop Index** to stop index(angle) \\[0-360\\].\n5. Click the **[
[Refresh](Std_Refresh.md)** icon in the tool bar.\n6. Wait for the results\\...\n\n##### Notes About Rotational Scans \n\n- **Rotational** scans require much more time and processing than **Planar** scans. Factors affecting processing time include: Sample Interval, Step Over, tool diameter, and model size. Again, rotational scans can take a long time. Some might take 3, 5 or 10 minutes or longer.\n- For time purposes, it is better that you not recompute a rotational scan after every property change; rather, consider one of the following:\n - use the \\' *change all settings with ENTER key* \\' technique mentioned in Step 2 above, then **[
[Refresh](Std_Refresh.md)** the operation.\n - deactivate the operation with the **
[Active](CAM_OpActiveToggle.md)** toggle tool, make your changes to the operation\\'s properties, then click the **
[Active](CAM_OpActiveToggle.md)** icon again to re-activate the operation - which triggers a recompute internally.\n- The **
[3D Surface](CAM_Surface.md)** operation is still considered an *experimental feature* as of 2019-06-25. As such, it may contain a few bugs yet to be clearly identified. Please report bugs and issues in the [FreeCAD Path/CAM Forum](https://forum.freecadweb.org/viewforum.php?f=15).\n- The built in **
[CAM Simulator](CAM_Simulator.md)** does NOT support 4th-axis simulation. You will need to use a third party simulator to inspect or verify paths visually. See the [Resources](#Resources.md) section below for suggestions.\n- You will likely see red rotational lines around your model in the viewport. This is normal in FreeCAD for the time being.\n\n##### Notes About Scans of complex models \n\nExcessively long processing times (longer than 10 minutes) can occur when processing large complex models. In addition to the factors already mentioned the following steps could help identify potential causes and solutions.\n\n***Low Memory***\nCheck how much memory is available while the scan is running using a tool such as the Windows **Task Manager, Memory tab**. If more than 90% of memory is consistently being used then a small **Linear Deflection** parameter could be generating a mesh that is too large for the available memory.\nTo confirm this \\...\n\n1. Create a new **
[3D Surface](CAM_Surface.md)** operation.\n2. Switch to the Model tab and increase the **Linear Deflection** value. For example change from 2.5um to 20um\n3. Switch back to the Tasks tab to complete setting up the operation.\n4. Click **OK** button to confirm and generate paths.\n\nTo make this value the default for all new **
[3D Surface](CAM_Surface.md)** operations, change the **GeometryTolerance** parameter.\n**Tools → Edit Parameters ... → Preferences → Mod → CAM → GeometryTolerance **.\nNote as of version 0.19 the **Linear Deflection** default = GeometryTolerance / 4\n\n***Invalid Geometry***\nIf a model contains invalid geometry the scanning time can increase significantly. A model can be checked using the [Part CheckGeometry](Part_CheckGeometry.md) function in
**Part Workbench**.\nTo run the tool:\n\n1. Switch to the
**Part Workbench** and select the model to check\n2. Click on the **
[Part CheckGeometry](Part_CheckGeometry.md)** button available in the Part workbench toolbar OR use the **Part →
Check geometry** entry from the top menu.\n3. Click the **Run Check** button and review the results.\n\nIf the results includes items like *BOPAlgo SelfIntersect* then the geometry is invalid and should be corrected by adjusting the model.\n(Hint: Boolean operations and Loft commands can sometimes introduce *Self Intersections*)\n\n#### Available Tool (Cutter) Shapes \n\nThis 3D Surface op currently uses [OpenCamLib](OpenCamLib.md) to extract paths from the part base. As such, a tool setting translation is required between the FreeCAD tool controller and OCL in order to complete the scan with your chosen tool(cutter) shape.\n\nThese tool shapes are respected and available for this 3D Surface operation:\n\n- End mill\n- Ball end mill\n- Bull nose end mill\n- Chamfer bit\n- Engraver\n\nShould you choose to run the path simulator in the CAM Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.\n\nNOTE: As of May 2019, only the End Mill has any type of testing to determine accuracy of the FreeCAD-to-OCL tool settings translation. Please post any feedback for non-end-mill usage to the [Path/CAM](https://forum.freecadweb.org/viewforum.php?f=15) section in the FreeCAD forums.\n\n## Properties: Version 0.19 \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|Clearing Options}}\n\n- **Bound Box**: Should the operation be limited by the stock object or by the bounding box of the base object\n\n- **Cut Mode**: The direction that the toolpath should go around the part: Climb(ClockWise) or Conventional(CounterClockWise)\n\n- **Cut Pattern**: Clearing pattern to use\n\n- **Cut Pattern Reversed**: Reverse the cut order of the stepover paths. For circular cut patterns, begin at the outside and work toward the center\n\n- **Depth Offset**: Z-axis offset from the surface of the object\n\n- **Layer Mode**: The completion mode for the operation: single or multi-pass\n\n- **Pattern Center At**: Choose location of the center point for starting the cut pattern\n\n- **Pattern Center Custom**: Set the start point for the cut pattern\n\n- **Profile Edges**: Profile the edges of the selection. There are the following options (images can be seen in this forum post: ):\n\n - \n **None**\n \n : Don\\'t create a profile\n\n - \n **Only**\n \n : Create only a profile and no inner paths\n\n - \n **First**\n \n : Start with the profile and then do the rest\n\n - \n **Last**\n \n : Start with the rest and then do the profile\n\n- **Sample Interval**: The Sample Interval. Small values cause long wait times\n\n- **Step Over**: Step over percentage of the drop cutter path\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- **Safe Height**: The above which Rapid motions are allowed.\n\n- **Start Depth**: Starting Depth of Tool- first cut depth in Z\n\n- **Step Down**: Incremental Step Down of Tool\n\n\n{{TitleProperty|Mesh Conversion}}\n\n- **Angular Deflection**: Smaller values yield a finer, more accurate mesh. Smaller values increase processing time a lot\n\n- **Linear Deflection**: Smaller values yield a finer, more accurate mesh. Smaller values do not increase processing time much but can increase memory comsumption\n\n\n{{TitleProperty|Optimization}}\n\n- **Circular Use G2 G3**: Convert co-planar arcs to G2/G3 gcode commands for \\Circular\\ and \\CircularZigZag\\ cut patterns\n\n- **Gap Sizes**: Feedback: three smallest gaps identified in the path geometry\n\n- **Gap Threshold**: Collinear and co-radial artifact gaps that are smaller than this threshold are closed in the path\n\n- **Optimize Linear Paths**: Enable optimization of linear paths (co-linear points). Removes unnecessary co-linear points from G-Code output\n\n- **Optimize Step Over Transitions**: Enable separate optimization of transitions between, and breaks within, each step over path\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**: Coolant mode for this operation\n\n- **Cycle Time**: Operations Cycle Time Estimation\n\n- **Tool Controller**: Defines the Tool controller used in the Operation\n\n- **User Label**: User assigned label\n\n\n{{TitleProperty|Rotation}}\n\n- **Cutter Tilt**: Set the cutter (spindle) tilt angle.\n\n- **Drop Cutter Dir**: The direction along which dropcutter lines are created\n\n- **Drop Cutter Extra Offset**: Additional offset to the selected bounding box - use sub-properties to set values\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- **Rotation Axis**: Set the axis for model rotation.\n\n- **Start Index**: Start index(angle) for rotation\n\n- **Stop Index**: Stop index(angle) for rotation\n\n\n{{TitleProperty|Selected Geometry Settings}}\n\n- **Avoid Last X Faces**: Avoid cutting the last \\'N\\' faces in the Base Geometry list of selected faces\n\n- **Avoid Last X Internal Features**: Do not cut internal features on avoided faces\n\n- **Boundary Adjustment**: Positive values push the cutter toward, or beyond, the boundary. Negative values retract the cutter away from the boundary\n\n- **Boundary Enforcement**: If true, the cutter will remain inside the boundaries of the model or selected face(s)\n\n- **Handle Multiple Features**: Choose how to process multiple Base Geometry features\n\n- **Internal Features Adjustment**: Positive values push the cutter toward, or into, the feature. Negative values retract the cutter away from the feature\n\n- **Internal Features Cut**: Cut internal feature areas within a larger selected face\n\n\n{{TitleProperty|Start Point}}\n\n- **Start Point**: The custom start point for the path of this operation, 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- **Use Start Point**: Make True, if specifying a Start Point\n\n\n{{TitleProperty|Surface}}\n\n- **Scan Type**: Planar: Flat, 3D surface scan. Rotational: 4th-axis rotational scan.\n\n\n{{TitleProperty|Waste}}\n\n- **Ignore Waste**: Ignore areas that proceed below specified depth.\n\n- **Ignore Waste Depth**: Depth used to identify waste areas to ignore.\n\n- **Release From Waste**: Cut through waste to depth at model edge, releasing the model.\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 Location \n\n- **Base Geometry import selection**: Use this list to select Base Geometry to be imported from the selected, existing operation\n- **Import**: Imports the selected operation\\'s Base Geometry into the current operations Base Geometry list\n- **Base Geometry list for current operation**: List of Base Geometry for current operation, if any selected\n- **Add**: Adds selected element(s) which should be the base(s) for the path(s)\n- **Remove**: Remove the selected item(s) in the Base Location list\n- **Clear**: Clear all items in the Base Location list\n\n### Depth\n\n- **Start Depth**\n \n\n- **Final Depth**\n \n\n- **Step Down**\n \n\n### Height\n\n- **Safe Height**\n \n\n- **Clearance Height**\n \n\n### Operation\n\n- **Tool Controller**\n \n\n- **Coolant Mode**\n \n\n- **BoundBox**\n \n\n- **Scan Type**\n \n\n- **Layer Mode**\n \n\n- **BoundBox extra offset X**\n \n\n- **BoundBox extra offset Y**\n \n\n- **Drop Cutter Direction**\n \n\n- **Depth Offset**\n \n\n- **Step Over**\n \n\n- **Sample Interval**\n \n\n- **Optimize Output Enabled**\n \n\n- **Use Start Point**\n \n\n- **Boundary Enforcement**\n \n\n- **Optimize Linear Paths**\n \n\n## Resources\n\n- G-code(path) simulator: [NCViewer](https://ncviewer.com/)\n- G-code(path) simulator: [CAMotics](https://www.camotics.org/)\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Surface\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 4414, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_Workbench.md", "text": "#
CAM Workbench\n\n \n\n## Introduction\n\nThe
[CAM Workbench](CAM_Workbench.md) is used to produce machine instructions for [CNC machines](https://en.wikipedia.org/wiki/CNC_router) from a FreeCAD 3D model. These produce real-world 3D objects on CNC machines such as mills, lathes, lasercutters, or similar. Typically, instructions are a [G-code](https://en.wikipedia.org/wiki/G-code) dialect. A [general CNC lathe tool path sequence simulation example](https://www.ange-softs.com/SIMULCNCHTML/index.html) is presented here.\n\n
\n\nThe FreeCAD CAM Workbench workflow creates these machine instructions as follows:\n\n- A 3D model is the base object, typically created using one or more of the
[Part Design](PartDesign_Workbench.md),
[Part](Part_Workbench.md) or
[Draft](Draft_Workbench.md) Workbenches.\n- A [CAM Job](CAM_Job.md) is created in the CAM Workbench. This contains all the information required to generate the necessary G-code to process the Job on a CNC mill: there is Stock material, the mill has a certain [set of tools](CAM_ToolBitLibraryOpen.md) and it follows certain commands controlling speed and movements (usually G-code).\n- [CAM Tools](CAM_Tools.md) are selected as required by the Job Operations.\n- Milling paths are created using e.g. [Contour](CAM_Profile.md) and [Pocket](CAM_Pocket_3D.md) Operations. These CAM objects use internal FreeCAD G-code dialect, independent of the CNC machine.\n- Export the job with a G-code, matching to your machine. This step is called *post processing*; there are different post processors available.\n\n## General concepts \n\nThe CAM Workbench generates G-code defining the paths required to mill the Project represented by the 3D model on the target mill in [the CAM Job Operations FreeCAD G-code dialect](CAM_scripting#The_FreeCAD_Internal_GCode_Format.md), which is later translated to the appropriate dialect for the target CNC controller by selecting the appropriate postprocessor.\n\nThe G-code is generated from directives and Operations contained in a CAM Job. The Job Workflow lists these in the order they will be executed. The list is populated by adding CAM Operations, Path Dressups, Supplemental Commands, and Path Modifications from the CAM Menu, or GUI buttons.\n\nThe CAM Workbench provides a Tool Manager (Library, Tool-Table), and G-code Inspection, and Simulation tools. It links the Postprocessor, and allows importing and exporting Job Templates.\n\nThe CAM Workbench has external dependencies including:\n\n1. The FreeCAD 3D model units are defined in the **Edit → Preference → General → Default unit system**. The Postprocessor configuration defines the final G-code units.\n2. The Macro file path, and Geometric tolerances, are defined in the **Edit → Preferences → CAM → Job Preferences** tab.\n3. Colors are defined in the **Edit → Preferences → CAM → GUI** tab.\n4. Holding tag parameters are defined in the **Edit → Preferences → CAM → Dressups** tab.\n5. That the Base 3D model quality supports the CAM workbench requirements, passes Check Geometry.\n\n## Limitations\n\nSome current limitations of which you should be aware are:\n\n- Most of the CAM Tools are not true 3D tools but only 2.5D capable. This means that they take a fixed 2D shape and can cut it down to a given depth. However, there are two tools which produce true 3D paths: **
[3D Pocket](CAM_Pocket_3D.md)** and **
[3D Surface](CAM_Surface.md)** (which is still an [experimental feature](CAM_experimental.md) as of November 2020).\n- Most of CAM workbench is designed for a simple, standard 3-axis (xyz) CNC mill/router, but lathe tools are under development in 0.19_pre.\n- Most operations in CAM workbench will return paths based on a standard endmill tool/bit only, regardless of the tool/bit type assigned in a given tool controller with the exception of the **
[Engrave](CAM_Engrave.md)** and **
[3D Surface](CAM_Surface.md)** operations.\n- The operations within the CAM workbench are not aware of clamping mechanisms in use to secure the model to your machine. Consequently, please review and simulate the paths you generate prior to sending the code to your machine. If necessary, model your clamping mechanisms in FreeCAD in order to better inspect the paths generated. Look for possible collisions with clamps or other obstacles along the paths.\n\n## Units\n\nUnit handling in CAM can be confusing. There are several points to understand:\n\n1. FreeCAD base units for length and time are \\'mm\\' and \\'s\\' respectively. Velocity is thus \\'mm/s\\'. This is what FreeCAD stores internally regardless of anything else\n2. The default unit schema uses the default units. If you\\'re using the default schema and you enter a feed rate without a unit string, it will get entered as \\'mm/s\\'\n3. Most CNC machines expect feed rate in the form of either \\'mm/min\\' or \\'in/min\\'. Most post-processors will automatically convert the unit when generating gcode.\n\nSchemas:\n\n1. Changing schema in preferences changes default unit string for the input fields. If you\\'re a CAM user and prefer to design in metric, it\\'s highly recommended that you use the \\\"Metric Small Parts & CNC\\\" schema. If you design in US units, either the Imperial Decimal and Building US will work.\n2. Changing your preferred unit schema will have no effect on output but will help avoid input errors.\n\nOutput:\n\n1. Generating the correct unit in output is the responsibility of the post-processor and is done only at that time.\n2. Machine output unit is completely unrelated to your selected unit schema.\n3. Post-processors produce either metric (G21) output, Imperial (G20) output or are configurable.\n4. Configurable post-processors default to metric (G21).\n5. If you want your configurable post-processor to output imperial G-code (G20), set the correct argument in your job output configuration (ie \\--inches for linuxcnc). This can be stored in a job template and set as your default template to make it automatic for all future jobs.\n\nCAM Inspection:\n\n1. If you use the CAM Inspect tool to look at G-code, you will see it in \\'mm/s\\' because it is not being post-processed.\n\n## Heights and depths \n\nMany of the commands have various heights and depths:\n\n
\n*Visual reference for Depth properties (settings)*\n\n## Commands\n\nSome commands are experimental and not available by default. To enable them see [CAM experimental](CAM_experimental.md).\n\n### Project Commands \n\n-
[Job](CAM_Job.md): Creates a new CNC job.\n\n-
[Post Process](CAM_Post.md): Exports a project to G-code.\n\n-
[Check the CAM job for common errors](CAM_Sanity.md): Checks the selected job for missing values.\n\n-
[Export Template](CAM_ExportTemplate.md): Export the current job as a template.\n\n### Tool Commands \n\n-
[Inspect CAM Commands](CAM_Inspect.md): Shows the G-code for checking.\n\n-
[CAM Simulator](CAM_Simulator.md): Shows the milling operation like it\\'s done on the machine.\n\n-
[CAM SimulatorGL](CAM_SimulatorGL.md): Enables the new, improved CAM simulator. (v1.0) \n\n-
[Finish Selecting Loop](CAM_SelectLoop.md): Completes a loop from two selected edges.\n\n-
[Toggle the Active State of the Operation](CAM_OpActiveToggle.md): Activates or de-activates a path operation.\n\n-
[ToolBit Library editor](CAM_ToolBitLibraryOpen.md): Opens an editor to manage ToolBit libraries.\n\n-
[ToolBit Dock](CAM_ToolBitDock.md): Toggles the ToolBit Dock.\n\n### Basic Operations \n\n-
[Profile](CAM_Profile.md): Creates a profile operation of the entire model, or from one or more selected faces or edges.\n\n-
[Pocket Shape](CAM_Pocket_Shape.md): Creates a pocketing operation from one or more selected pocket(s).\n\n-
[Drilling](CAM_Drilling.md): Performs a drilling cycle.\n\n-
[Face](CAM_MillFace.md): Creates a surfacing path.\n\n-
[Helix](CAM_Helix.md): Creates a helical path.\n\n-
[Adaptive](CAM_Adaptive.md): Creates an adaptive clearing and profiling operation.\n\n-
[Slot](CAM_Slot.md): Creates a slotting operation from selected features or custom points. [**Experimental**](CAM_experimental.md).\n\n-
[Engrave](CAM_Engrave.md): Creates an engraving path.\n\n-
[Deburr](CAM_Deburr.md): Creates a deburr path.\n\n-
[Vcarve](CAM_Vcarve.md): Creates an engraving path using a V tool shape.\n\n### 3D Operations \n\n-
[3D Pocket](CAM_Pocket_3D.md): Creates a path for a 3D pocket.\n\n-
[3D Surface](CAM_Surface.md): Creates a path for a 3D surface. [**Experimental**](CAM_experimental.md).\n\n-
[Waterline](CAM_Waterline.md): Creates a waterline path for a 3D surface. [**Experimental**](CAM_experimental.md).\n\n### Path Dressup \n\n-
[Axis Map](CAM_DressupAxisMap.md): Remaps one axis to another.\n\n-
[Boundary](CAM_DressupPathBoundary.md): Adds a boundary dressup modification to a selected path.\n\n-
[Dogbone](CAM_DressupDogbone.md): Adds a dogbone dressup modification to a selected path.\n\n-
[DragKnife](CAM_DressupDragKnife.md): Adds a dragknife dressup modification to a selected path.\n\n-
[LeadInOut](CAM_DressupLeadInOut.md): Adds a lead-in and/or lead-out point to a selected path.\n\n-
[RampEntry](CAM_DressupRampEntry.md): Adds ramp entry dressup modification to a selected path.\n\n-
[Tag](CAM_DressupTag.md): Adds a holding tag dressup modification to a selected path.\n\n-
[Z Depth Correction](CAM_DressupZCorrect.md): Corrects the Z depth using Probe Map.\n\n### Supplemental Commands \n\n-
[Fixture](CAM_Fixture.md): Changes the fixture position.\n\n-
[Comment](CAM_Comment.md): Inserts a comment in the G-code of a path.\n\n-
[Stop](CAM_Stop.md): Inserts a full stop of the machine.\n\n-
[Custom](CAM_Custom.md): Inserts custom G-code.\n\n-
[Probe](CAM_Probe.md): Creates a Probing Grid from a job stock.\n\n-
[From Shape](CAM_Shape.md): Creates a path object from a selected Part object. [**Experimental**](CAM_experimental.md).\n\n### Path Modification \n\n-
[Copy the operation in the job](CAM_Copy.md): Creates a parametric Copy of a selected path object.\n\n-
[Array](CAM_Array.md): Creates an array by duplicating a selected path.\n\n-
[Simple Copy](CAM_SimpleCopy.md): Creates a non-parametric copy of a selected path object.\n\n### Specialty Operations \n\n-
[Thread Milling](CAM_ThreadMilling.md): Creates a CAM Thread Milling operation from features of a base object. [**Experimental**](CAM_experimental.md).\n\n### Miscellaneous\n\n-
[Area](CAM_Area.md): Creates a feature area from selected objects. [**Experimental**](CAM_experimental.md).\n\n-
[Area workplane](CAM_Area_Workplane.md): Creates a feature area workplane. [**Experimental**](CAM_experimental.md).\n\n## ToolBit architecture \n\nManage tools, bits, and the Tool Library. Based on the ToolBit architecture.\n\n- [CAM Tools](CAM_Tools.md)\n- [CAM ToolShape](CAM_ToolShape.md)\n- [CAM ToolBit](CAM_ToolBit.md)\n- [CAM ToolBit Library](CAM_ToolBit_Library.md)\n- [CAM ToolController](CAM_ToolController.md)\n\n## Other\n\n- [CAM FAQ](CAM_FAQ.md): The CAM Workbench shares many concepts with other CAM software packages but has its own peculiarities. If something seems wrong this is a good place to start.\n- [CAM SetupSheet](CAM_SetupSheet.md): You can use a SetupSheet to customize how various property values for operations are calculated.\n- [CAM Postprocessor Customization](CAM_Postprocessor_Customization.md): If you have a special machine which cannot use one of the available post-processors you may need to write your own post-processor.\n- [CAM fourth axis](CAM_fourth_axis.md): Experimental four axis milling.\n\n## Preferences\n\n-
[Preferences\\...](CAM_Preferences.md): Preferences available for the CAM Workbench.\n\n## Scripting\n\nSee [CAM scripting](CAM_scripting.md).\n\n## Tutorials\n\n- [CAM Walkthrough for the Impatient](CAM_Walkthrough_for_the_Impatient.md): a quick tutorial to get familiar with CAM.\n\n## Videos\n\n- [FreeCAD Path: Custom paths with Python - Part 1 - 5](https://www.youtube.com/playlist?list=PLEuOia-QxyFKgzAeTyH62GKqWKVURiWJL): A playlist with a series of 5 videos in English by sliptonic. This series shows how to work with the [CAM Workbench](CAM_Workbench.md).\n- [FreeCAD CAM Path Workbench](https://www.youtube.com/playlist?list=PLUrr_kHPp4vhGdLlj6IemtF-OPUlRvSTC): A playlist with a series of 7 videos in English by CAD CAM Lessons.\n- [FreeCAD CAM CNC](https://www.youtube.com/playlist?list=PLUrr_kHPp4vh2n6DcIlegK4dEKIFjmISJ): A playlist with a series of 8 videos in English by CAD CAM Lessons.\n- Also see the [Computer-Aided Manufacturing (CAM) section](Video_tutorials#Computer-Aided_Manufacturing_(CAM).md) of the [Video tutorials](Video_tutorials.md) wiki page.\n\n## Roadmap\n\n- [CAM Development Roadmap](CAM_Development_Roadmap.md): Read this if you are a developer and want to contribute to CAM.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [CAM](Category_CAM.md) > CAM Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 4299, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/CAM_experimental.md", "text": "# CAM experimental\n## Description\n\nThe CAM Workbench contains a set of hidden commands. They are hidden by default because they are experimental. A command can be considered experimental for any of the following reasons:\n\n- It is incomplete.\n- It is bug-ridden.\n- It is unstable.\n- It does not produce correct, stable, safe, paths.\n- It is not a standard, regularly used command in the traditional CAM workflow.\n- It is mature but has not yet been moved to the standard tool list.\n- \\... other reasons.\n\n## Enable experimental commands \n\nTo access the hidden experimental commands of the CAM Workbench, the user must enable them in the [Parameter Editor](Std_DlgParameter.md).\n\n1. Open the [Parameter Editor](Std_DlgParameter.md) via **Tools → Edit Parameters...**\n2. Once in the editor the path is **BaseApp → Preferences → Mod → CAM**\n3. To enable the [CAM Area](CAM_Area.md) and [CAM Area Workplane](CAM_Area_Workplane.md) commands:\n - Right-click in the parameter list area and select **New → New Boolean item** from the context menu.\n - Name the new parameter: `EnableAdvancedOCLFeatures` (case-sensitive).\n - Set it to: `True`.\n4. To enable the other experimental commands:\n - Again select **New → New Boolean item** from the context menu.\n - Name the new parameter: `EnableExperimentalFeatures` (case-sensitive).\n - Set it to: `True`.\n5. Save the settings.\n6. Restart FreeCAD.\n\n## Additional Information \n\nRead more about the specific experimental commands on the [wiki pages that link to this one](https://www.freecadweb.org/wiki/Special:WhatLinksHere/CAM_experimental).\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Poweruser_Documentation](Category_Poweruser_Documentation.md) > [CAM](CAM_Workbench.md) > CAM experimental\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 438, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Administration.md", "text": "# Category:Administration\nThis category contains articles and categories about wiki administrative subjects.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:Arch Tools navi](Template_Arch_Tools_navi.md) | [Template:ASCII](Template_ASCII.md) | [Template:Assembly Tools navi](Template_Assembly_Tools_navi.md) |\n| [Backend Adminstration](Backend_Adminstration.md) | [Template:BIM Tools navi](Template_BIM_Tools_navi.md) | [Template:CAM Tools navi](Template_CAM_Tools_navi.md) |\n| [Template:CfdOF Tools navi](Template_CfdOF_Tools_navi.md) | [Changelog](Changelog.md) | [Template:Choice](Template_Choice.md) |\n| [Template:Code](Template_Code.md) | [Template:ColoredParagraph](Template_ColoredParagraph.md) | [Template:ColoredText](Template_ColoredText.md) |\n| [Crowdin Administration](Crowdin_Administration.md) | [Crowdin Scripts](Crowdin_Scripts.md) | [Template:Delete](Template_Delete.md) |\n| [Template:Development-Version](Template_Development-Version.md) | [Template:Disambig](Template_Disambig.md) | [Template:Docnav](Template_Docnav.md) |\n| [Template:Document objects navi](Template_Document_objects_navi.md) | [Template:Draft Tools navi](Template_Draft_Tools_navi.md) | [Template:Drawing Tools navi](Template_Drawing_Tools_navi.md) |\n| [Template:EM Tools navi](Template_EM_Tools_navi.md) | [Template:Emphasis](Template_Emphasis.md) | [Template:ExampleCode](Template_ExampleCode.md) |\n| [Template:FALSE](Template_FALSE.md) | [Template:False](Template_False.md) | [Template:FALSE/pl](Template_FALSE/pl.md) |\n| [Template:False/pl](Template_False/pl.md) | [Template:FEM Tools navi](Template_FEM_Tools_navi.md) | [Template:FileName](Template_FileName.md) |\n| [Template:Hello](Template_Hello.md) | [Template:Image Tools navi](Template_Image_Tools_navi.md) | [Template:Incode](Template_Incode.md) |\n| [Template:Interface navi](Template_Interface_navi.md) | [Template:KEY](Template_KEY.md) | [Template:LineEdit](Template_LineEdit.md) |\n| [Template:MacroCode](Template_MacroCode.md) | [Template:MenuCommand](Template_MenuCommand.md) | [Template:Mesh Tools navi](Template_Mesh_Tools_navi.md) |\n| [Template:Message](Template_Message.md) | [Template:Movie Tools navi](Template_Movie_Tools_navi.md) | [Template:Navigation menu 2](Template_Navigation_menu_2.md) |\n| [Template:OpenSCAD Tools navi](Template_OpenSCAD_Tools_navi.md) | [Template:Optional](Template_Optional.md) | [Organization chart](Organization_chart.md) |\n| [Template:Parameter](Template_Parameter.md) | [Template:Part Tools navi](Template_Part_Tools_navi.md) | [Template:PartDesign Tools navi](Template_PartDesign_Tools_navi.md) |\n| [Template:Plot Tools navi](Template_Plot_Tools_navi.md) | [Template:Points Tools navi](Template_Points_Tools_navi.md) | [Template:Powerdocnavi](Template_Powerdocnavi.md) |\n| [Template:Properties Title](Template_Properties_Title.md) | [Template:Properties Title/pl](Template_Properties_Title/pl.md) | [Template:PropertyData](Template_PropertyData.md) |\n| [Template:PropertyTasks](Template_PropertyTasks.md) | [Template:PropertyView](Template_PropertyView.md) | [Template:Raytracing Tools navi](Template_Raytracing_Tools_navi.md) |\n| [Release process](Release_process.md) | [Template:Robot Tools navi](Template_Robot_Tools_navi.md) | [Template:Sketcher Tools navi](Template_Sketcher_Tools_navi.md) |\n| [Template:Spreadsheet Tools navi](Template_Spreadsheet_Tools_navi.md) | [Template:Start Tools navi](Template_Start_Tools_navi.md) | [Template:Std Base navi](Template_Std_Base_navi.md) |\n| [Template:StdMenu](Template_StdMenu.md) | [Template:Surface Tools navi](Template_Surface_Tools_navi.md) | [Template:SystemInput](Template_SystemInput.md) |\n| [Template:SystemOutput](Template_SystemOutput.md) | [Template:TasksTag](Template_TasksTag.md) | [Template:TechDraw Tools navi](Template_TechDraw_Tools_navi.md) |\n| [Template:TitleTasks](Template_TitleTasks.md) | [Template:Top](Template_Top.md) | [Tracker](Tracker.md) |\n| [Template:TRUE](Template_TRUE.md) | [Template:True](Template_True.md) | [Template:TRUE/pl](Template_TRUE/pl.md) |\n| [Template:True/pl](Template_True/pl.md) | [Template:UnfinishedDocu](Template_UnfinishedDocu.md) | [Template:URL](Template_URL.md) |\n| [Template:URLn](Template_URLn.md) | [Template:Userdocnavi](Template_Userdocnavi.md) | [Template:Value](Template_Value.md) |\n| [Template:Variable](Template_Variable.md) | [Template:VeryImportantMessage](Template_VeryImportantMessage.md) | [Template:Web Tools navi](Template_Web_Tools_navi.md) |\n| [WikiPages](WikiPages.md) | [WikiRobots](WikiRobots.md) | [Category:Disambiguation](Category_Disambiguation.md) |\n| [Category:HouseKeeping](Category_HouseKeeping.md) | [Category:Pages to delete](Category_Pages_to_delete.md) | [Category:UnfinishedDocu](Category_UnfinishedDocu.md) |\n| [Category:Wiki](Category_Wiki.md) | [Category:Work in progress](Category_Work_in_progress.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Administration\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1361, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Mesh.md", "text": "# Category:Mesh\nThis category lists pages related to the [Mesh Workbench](Mesh_Workbench.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Artwork Mesh](Artwork_Mesh.md) | [Artwork MeshPart](Artwork_MeshPart.md) | [Asymptote](Asymptote.md) |\n| [Asymptote/pl](Asymptote/pl.md) | [Manual:Preparing models for 3D printing](Manual_Preparing_models_for_3D_printing.md) | [Mesh](Mesh.md) |\n| [Mesh AddFacet](Mesh_AddFacet.md) | [Mesh AddFacet/pl](Mesh_AddFacet/pl.md) | [Mesh BoundingBox](Mesh_BoundingBox.md) |\n| [Mesh BoundingBox/pl](Mesh_BoundingBox/pl.md) | [Mesh BuildRegularSolid](Mesh_BuildRegularSolid.md) | [Mesh BuildRegularSolid/pl](Mesh_BuildRegularSolid/pl.md) |\n| [Mesh CrossSections](Mesh_CrossSections.md) | [Mesh CrossSections/pl](Mesh_CrossSections/pl.md) | [Mesh CurvatureInfo](Mesh_CurvatureInfo.md) |\n| [Mesh CurvatureInfo/pl](Mesh_CurvatureInfo/pl.md) | [Mesh Decimating](Mesh_Decimating.md) | [Mesh Decimating/pl](Mesh_Decimating/pl.md) |\n| [Mesh Difference](Mesh_Difference.md) | [Mesh Difference/pl](Mesh_Difference/pl.md) | [Mesh EvaluateFacet](Mesh_EvaluateFacet.md) |\n| [Mesh EvaluateFacet/pl](Mesh_EvaluateFacet/pl.md) | [Mesh EvaluateSolid](Mesh_EvaluateSolid.md) | [Mesh EvaluateSolid/pl](Mesh_EvaluateSolid/pl.md) |\n| [Mesh Evaluation](Mesh_Evaluation.md) | [Mesh Evaluation/pl](Mesh_Evaluation/pl.md) | [Mesh Export](Mesh_Export.md) |\n| [Mesh Export/pl](Mesh_Export/pl.md) | [Mesh Feature](Mesh_Feature.md) | [Mesh Feature/pl](Mesh_Feature/pl.md) |\n| [Mesh FillInteractiveHole](Mesh_FillInteractiveHole.md) | [Mesh FillInteractiveHole/pl](Mesh_FillInteractiveHole/pl.md) | [Mesh FillupHoles](Mesh_FillupHoles.md) |\n| [Mesh FillupHoles/pl](Mesh_FillupHoles/pl.md) | [Mesh FlipNormals](Mesh_FlipNormals.md) | [Mesh FlipNormals/pl](Mesh_FlipNormals/pl.md) |\n| [Mesh FromPartShape](Mesh_FromPartShape.md) | [Mesh FromPartShape/pl](Mesh_FromPartShape/pl.md) | [Mesh HarmonizeNormals](Mesh_HarmonizeNormals.md) |\n| [Mesh HarmonizeNormals/pl](Mesh_HarmonizeNormals/pl.md) | [Mesh Import](Mesh_Import.md) | [Mesh Import/pl](Mesh_Import/pl.md) |\n| [Mesh Intersection](Mesh_Intersection.md) | [Mesh Intersection/pl](Mesh_Intersection/pl.md) | [Mesh Merge](Mesh_Merge.md) |\n| [Mesh Merge/pl](Mesh_Merge/pl.md) | [Mesh MeshObject](Mesh_MeshObject.md) | [Mesh MeshObject/pl](Mesh_MeshObject/pl.md) |\n| [Mesh PolyCut](Mesh_PolyCut.md) | [Mesh PolyCut/pl](Mesh_PolyCut/pl.md) | [Mesh PolyTrim](Mesh_PolyTrim.md) |\n| [Mesh PolyTrim/pl](Mesh_PolyTrim/pl.md) | [Mesh RemeshGmsh](Mesh_RemeshGmsh.md) | [Mesh RemeshGmsh/pl](Mesh_RemeshGmsh/pl.md) |\n| [Mesh RemoveCompByHand](Mesh_RemoveCompByHand.md) | [Mesh RemoveCompByHand/pl](Mesh_RemoveCompByHand/pl.md) | [Mesh RemoveComponents](Mesh_RemoveComponents.md) |\n| [Mesh RemoveComponents/pl](Mesh_RemoveComponents/pl.md) | [Mesh Scale](Mesh_Scale.md) | [Mesh Scale/pl](Mesh_Scale/pl.md) |\n| [Mesh Scripting](Mesh_Scripting.md) | [Mesh Scripting/pl](Mesh_Scripting/pl.md) | [Mesh SectionByPlane](Mesh_SectionByPlane.md) |\n| [Mesh SectionByPlane/pl](Mesh_SectionByPlane/pl.md) | [Mesh Segmentation](Mesh_Segmentation.md) | [Mesh Segmentation/pl](Mesh_Segmentation/pl.md) |\n| [Mesh SegmentationBestFit](Mesh_SegmentationBestFit.md) | [Mesh SegmentationBestFit/pl](Mesh_SegmentationBestFit/pl.md) | [Mesh Smoothing](Mesh_Smoothing.md) |\n| [Mesh Smoothing/pl](Mesh_Smoothing/pl.md) | [Mesh SplitComponents](Mesh_SplitComponents.md) | [Mesh SplitComponents/pl](Mesh_SplitComponents/pl.md) |\n| [Mesh to Part](Mesh_to_Part.md) | [Mesh to Part/pl](Mesh_to_Part/pl.md) | [Template:Mesh Tools navi](Template_Mesh_Tools_navi.md) |\n| [Mesh TrimByPlane](Mesh_TrimByPlane.md) | [Mesh TrimByPlane/pl](Mesh_TrimByPlane/pl.md) | [Mesh Union](Mesh_Union.md) |\n| [Mesh Union/pl](Mesh_Union/pl.md) | [Mesh VertexCurvature](Mesh_VertexCurvature.md) | [Mesh VertexCurvature/pl](Mesh_VertexCurvature/pl.md) |\n| [Mesh Workbench](Mesh_Workbench.md) | [Mesh Workbench/pl](Mesh_Workbench/pl.md) | [Mesh/pl](Mesh/pl.md) |\n| [MeshPart CreateFlatFace](MeshPart_CreateFlatFace.md) | [MeshPart CreateFlatFace/pl](MeshPart_CreateFlatFace/pl.md) | [MeshPart CreateFlatMesh](MeshPart_CreateFlatMesh.md) |\n| [MeshPart CreateFlatMesh/pl](MeshPart_CreateFlatMesh/pl.md) |\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [User_Documentation](Category_User_Documentation.md) > Category:Mesh\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1303, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Template_Effect.md", "text": "# Category:Template:Effect\nThis category lists templates that produce an effect in the page without necessarily printing anything.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:Anchor](Template_Anchor.md) | [Template:Clear](Template_Clear.md) | [Template:Gloss](Template_Gloss.md) |\n| [Template:Glossend](Template_Glossend.md) | [Template:Prettytable](Template_Prettytable.md) | [Template:Softredirect](Template_Softredirect.md) |\n| [Template:TOCleft](Template_TOCleft.md) | [Template:TOCright](Template_TOCright.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Template:Effect\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 164, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Category_Template_Image.md", "text": "# Category:Template:Image\nThis category lists templates that add images.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:En](Template_En.md) | [Template:Screenshot](Template_Screenshot.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Template:Image\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 75, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Curves_Discretize.md", "text": "---\n GuiCommand:\n Name: Curves Discretize\n MenuLocation: Curves , Discretize\n Workbenches: Curves_Workbench\n---\n\n# Curves Discretize\n\n## Description\n\nThe
[Curves Discretize](Curves_Discretize.md) command allows to discretize an edge or a wire. This tool is part of the [external workbench](External_workbenches.md) called [Curves](Curves_Workbench.md).\n\n## Usage\n\n1. Switch to the
[Curves](Curves_Workbench.md) workbench (install from
[Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. To invoke the command, do one of the following:\n - Press the
button in the Curves toolbar.\n - Use the **Curves → Discretize** entry in the dropdown menu.\n\n## Notes\n\n## Limitations\n\n## Properties\n\n## Scripting\n\n\n {{Curves Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Curves](Category_Curves.md) > Curves Discretize\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 325, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Curves_SegmentSurface.md", "text": "---\n GuiCommand:\n Name: Curves SegmentSurface\n MenuLocation: Surfaces , Segment surface\n Workbenches: Curves_Workbench\n---\n\n# Curves SegmentSurface\n\n## Description\n\nThe
[Curves SegmentSurface](Curves_SegmentSurface.md) allows to segment a surface on isocurves. This tool is part of the [external workbench](External_workbenches.md) called [Curves](Curves_Workbench.md).\n\n## Usage\n\n1. Switch to the
[Curves](Curves_Workbench.md) workbench (install from
[Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. To invoke the command, do one of the following:\n - Press the
button in the Curves toolbar.\n - Use the **Surfaces → Segment surface** entry in the dropdown menu.\n\n## Notes\n\n## Limitations\n\n## Properties\n\n## Scripting\n\n\n {{Curves Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Curves](Category_Curves.md) > Curves SegmentSurface\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 319, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/DAG_view.md", "text": "# DAG view\n## Introduction\n\n \n\nThe [DAG view](DAG_view.md) is a [directed acyclic graph](https://en.wikipedia.org/wiki/Directed_acyclic_graph) (DAG) that shows the relationships between different objects in the document. It is meant primarily to show how certain objects depend on others in a complex model with many features and references, such as those that can be created with the
[PartDesign Workbench](PartDesign_Workbench.md).\n\nThe DAG view resembles the graph that can be produced from a Git repository and its branches. Together with the standard [tree view](tree_view.md) and the [dependency graph](Std_DependencyGraph.md), the DAG view is a tool to inspect the parametric history of objects in a document.\n\n## Example\n\nA simple model will be seen with different views.\n\n \n*Model with 2D and 3D shapes.*\n\n
\n\n\n*Left: objects shown in the standard [tree view](tree_view.md). Right: objects shown in the DAG view.*\n\n\n\n\n*Relationships between the objects shown in the [dependency graph](Std_DependencyGraph.md).*\n\n## Activating the DAG view \n\nThe DAG view was introduced in 0.17 as an experimental feature for power users and developers, so they could troubleshoot complex models; therefore, the DAG view is not available by default.\n\nTo use this view use the [parameter editor](Std_DlgParameter.md). Create the following subgroup if it doesn\\'t exist\n\n- `BaseApp/Preferences/DockWindows/DAGView`\n \n\nthen add the parameter `Enabled` of type `Boolean`, and set it to `True`.\n\nRestart FreeCAD and activate DAG view: **{{StdMenu|[View](Std_View_Menu.md)** → Panels → DAG view}}.\n\nIn the [parameter editor](Std_DlgParameter.md) you can also change some properties in the following subgroup\n\n- `BaseApp/Preferences/DAGView`\n \n\n- FontPointSize - Set size of text font and can help with readability with high DPI displays. Set to 0 for default font size.\n\n- SelectionMode\n - 0 - single click selects an item. Ctrl-click to add items to selection.\n - 1 - every click adds/removes item to selection.\n\n- Direction - the order in which items are displayed.\n - 1 - child on top, parent under it\n - -1 - parent on top, children under it\n\n## Links\n\n- [DAGView](https://forum.freecadweb.org/viewtopic.php?f=20&t=11276), forum thread presenting the new tool.\n- [easter egg of PartDesign Next: DAG View](https://forum.freecadweb.org/viewtopic.php?t=15375), including the view together with the update to PartDesign.\n\n\n{{Interface navi\n\n}} {{Std Base navi}}\n\n\n---\n⏵ [documentation index](../README.md) > DAG view\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 703, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/DebianDevelopment.md", "text": "# DebianDevelopment\n1. REDIRECT [Debian development](Debian_development.md)\n\n\n---\n⏵ [documentation index](../README.md) > DebianDevelopment\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 36, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Defeaturing_Workbench.md", "text": "#
Defeaturing Workbench\n\n## Introduction\n\n \n\n
[Defeaturing Workbench](Defeaturing_Workbench.md) is an add-on workbench intended for editing STEP models, removing of the selected features from the model. It is an [external workbench](External_Workbenches.md) and therefore not part of the standard FreeCAD install.\n\n## Features\n\n- Features a set of tools to edit a Shape or a STEP model, removing hole(s), face(s), simplifying the model, changing the tolerance, applying Fuzzy Boolean operations etc\\...\n- There are also tools to create more solid shape(s), from edge(s), face(s) or shell(s).\n- It is also possible to use direct modeling of the model, when the history of operations is unavailable. (This is the case for 3D STEP models).\n- Useful in situations to quickly remove proprietary details of the model before sharing it. See [Defeaturing](Defeaturing.md)\n\nNote: More advance Defeaturing tools can be used if [OCC7.3](OpenCASCADE.md) is available.\n\n## Installation\n\n### Automatic (recommended) \n\nUsing the FreeCAD
[Addon Manager](Std_AddonMgr.md) available in v0.17+ via **Tools → Addon Manager**. Search for the
Defeaturing workbench icon. The Addon Manager also notifies the user when a new version of this Addon is available.\n\n### Manually\n\nSee [How to install additional workbenches](How_to_install_additional_workbenches.md)\n\n### Supports\n\n- FreeCAD v0.15 4671\n- FreeCAD v0.16 \\>= 6712\n- FreeCAD v0.17 \\>= 13522\n- FreeCAD v0.18+\n\n## References\n\n- Author: Github: [\\@easyw](https://github.com/easyw) \\| FreeCAD Forums: [1](https://forum.freecadweb.org/viewtopic.php?f=9&t=29506)\n- Source code on github: \n- FC forum thread \n\n## Tools\n\n\n\n
Defeaturing Tools are located in a separate mask.\n\n-
[Remove Holes](DefeatWB_Tools_rmv_hole.md): remove Hole from Face\n-
[Remove listed Faces](DefeatWB_Tools_rmv_listed_Faces.md): remove \\'in List\\' Faces\n-
[Add Faces from \\'in List\\' Edges](DefeatWB_Tools_add_Faces_listed_Edges.md): add Faces from \\'in List\\' Edges\n-
[Select Faces to be Parametric defeatured](DefeatWB_Tools_select_Faces_Param_Defeat.md): select Faces to be Parametric defeatured\n-
[Create a copy of the \\'in List\\' Edges ](DefeatWB_Tools_create_copy_listed_edges.md): create a copy of the \\'in List\\' Edges\n\n-
[copy Faces from \\'in List\\' Faces ](DefeatWB_Tools_copy_Faces_listed_faces.md): copy Faces from \\'in List\\' Faces\n-
[ offset face](DefeatWB_Tools_offset_face.md): offset face\n-
[offset edge](DefeatWB_Tools_offset_edge.md): offset edge\n\n-
[Make Solid from in List Faces](DefeatWB_Tools_make_solid_listed_faces.md): make Solid from in List Faces\n-
[Make Solid from the Faces of the selected Objects](DefeatWB_Tools_make_solid_faces_selected_objects.md): make Solid from the Faces of the selected Objects\n-
[Make Solid from in List Faces](DefeatWB_Tools_select_one_object_2_make_solid_step_proc.md): select ONE object to try to make a Solid through STEP import/export process\n-
[Connect](DefeatWB_Tools_Connect.md): connect\n-
[clean Face(s) removing holes and merging Outwire](DefeatWB_Tools_clean_face_rmv_holes.md): clean Face(s) removing holes and merging Outwire\n\n-
[show \\'in List' Edge(s)](DefeatWB_Tools_show_listed_edges.md): show \\'in List' Edge(s)\n-
[show \\'in List' Face(s)](DefeatWB_Tools_show_listed_faces.md): show \\'in List' Face(s)\n-
[refine](DefeatWB_Tools_refine.md): refine\n-
[simple copy](DefeatWB_Tools_simple_copy.md): simple copy\n-
[parametric Refine](DefeatWB_Tools_parametric_refine.md): parametric Refine\n\n-
[geometry check](DefeatWB_Tools_geometry_check.md): geometry check\n-
[get Tolerance value](DefeatWB_Tools_get_Tolerance_value.md): get Tolerance value\n-
[set Tolerance value](DefeatWB_Tools_set_Tolerance_value.md): set Tolerance value\n\n-
[make Edge from selected Vertexes](DefeatWB_Tools_make_edges_selected_vertexes.md): make Edge from selected Vertexes\n-
[reset Placement](DefeatWB_Tools_reset_placement.md): reset Placement\n-
[show/hide TypeId of the Shape](DefeatWB_Tools_show_hide_typeId_shape.md): show/hide Type Id of the Shape\n-
[help](DefeatWB_Tools_help.md): help\n\n-
[Fuzzy Cut](DefeatWB_Tools_Fuzzy_Cut.md): Fuzzy Cut\n-
[Fuzzy Union](DefeatWB_Tools_Fuzzy_Union.md): Fuzzy Union\n-
[Fuzzy Common](DefeatWB_Tools_Fuzzy_Common.md): Fuzzy Common\n\n## Video Tutorials \n\n### Defeaturing\n\nRemoving Features using OCC7.3 new tools\n\n[480px\\|left\\|thumb \\|link=: removing-features (holes)](Image:Defeaturing-WB-@Work_v3.png.md)\n\n[480px\\|left\\|thumb \\|link= \\|alt=Defeaturing-WB-@Work\\|YouTube: Defeaturing tools - Simplifying the model](Image:Defeaturing-WB-@Work_v1.png.md)\n\n[480px\\|left\\|thumb \\|link=: Defeaturing tools - Multi-select faces for defeaturing](Image:Defeaturing-WB-@Work_v2.png.md)\n\n[480px\\|left\\|thumb \\|link= - removing-fillet-chamfer](Image:Defeaturing-WB-@Work_v4.png.md)\n\n[480px\\|left\\|thumb \\|link= - overview-features (in german language)](Image:Defeaturing-WB-@Work_v5.png.md)\n\n[480px\\|left\\|thumb \\|link= - parametric-defeaturing](Image:Defeaturing-WB-@Work_v6.png.md) \n\n### Repairing\n\n- Sew a Shape\n- Removing or Simplify Faces\n- Remove Holes or Pockets\n- Read or Change Tolerance\n- make Fuzzy Boolean operations\n\n## External workbenches \n\nFreeCAD workbenches are easy to program in [Python](Python.md), there are therefore many people developing additional workbenches outside of the FreeCAD main developers.\n\nThe [external workbenches](external_workbenches.md) page has some information and tutorials on some of them, and the [FreeCAD Addons](https://github.com/FreeCAD/FreeCAD-addons) project aims at gathering them and making them easily installable from within FreeCAD.\n\nNew workbenches are in development, stay tuned!\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > Defeaturing Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2712, "license": "CC0-1.0", "author": "Open-source contributors"}
{"id": "freecad-docs:wiki/Design456_PartMerge.md", "text": "---\n GuiCommand:\n Name: Design456 PartMerge\n MenuLocation: Design456_Tools , 3DTools , Merge\n Workbenches: Design456 Workbench\n Shortcut: None\n SeeAlso: \n---\n\n# Design456 PartMerge\n\n## Description\n\nThe
**Part Merge** lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur at felis ut urna auctor pharetra id at nulla. This tool is part of the [external workbench](external_workbenches.md) called [Design456](Design456_Workbench.md).\n\n## Usage\n\n1. Switch to the
[Design456](Design456_Workbench.md) workbench (install from
[Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. Select two object to merge and run the
Part Merge command. This is just an interface for the Part merge command. Nothing added to the command.\n\n## Limitations\n\nWorks on 3D objects.\n\n## Properties\n\n\n{{Properties_Title|Base}}\n\n## Scripting\n\n\n---\n⏵ [documentation index](../README.md) > [External_Command_Reference](Category_External_Command_Reference.md) > Design456 PartMerge\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 333, "license": "CC0-1.0", "author": "Open-source contributors"}