{"id": "freecad-docs:wiki/Add_Workbench_to_Addon_Manager.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Add_Workbench_to_Addon_Manager.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Add_Workbench_to_Addon_Manager.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "da17537433e6351ff907e31b8c78f8b7104ae2c7f25dd097d89f98cef1d14a1d", "bytes": 3436, "tokens": 1084, "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 → Preferences...** option from the menu.\n2. Select the ** 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 → Addon manager** option from the menu.\n2. Press the **Developer tools...** button.\n3. The **Addon Developer Tools** dialog opens.\n \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 **** button at the bottom of the dialog.\n6. The **Content Item** dialog opens.\n \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 ** 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 .\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"}
{"id": "freecad-docs:wiki/Arch_MultiMaterial.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_MultiMaterial.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_MultiMaterial.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b82884d5c41d282d3362858f21e6a2aacb530ef42ba4f3756066c3343f21b420", "bytes": 3720, "tokens": 1118, "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- [Walls](Arch_Wall.md) with a MultiMaterial will use the material definitions and thicknesses to create a multi-layer wall\n- [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- [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 ** [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 ** [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"}
{"id": "freecad-docs:wiki/Arch_Preferences.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_Preferences.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_Preferences.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "723f57ea4ab9d7ee9ed33a477191930d8144d012a39676ef25447685e3e78157", "bytes": 136, "tokens": 51, "text": "# Arch Preferences\n1. REDIRECT [BIM_Preferences](BIM_Preferences.md)\n\n\n---\n⏵ [documentation index](../README.md) > Arch Preferences\n"}
{"id": "freecad-docs:wiki/Arch_Remove.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_Remove.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_Remove.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "247106c12f8d52ab3c20b029bc95508ee2d15055ad0e82c3a39ab1e0107fd7f2", "bytes": 2597, "tokens": 910, "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 ** [Arch Add](Arch_Add.md)** example.\n- Subtract a [shape](Part_Workbench.md)-based object from an Arch component such as a ** [Arch Wall](Arch_Wall.md)\n** or ** [Arch Structure](Arch_Structure.md)**\n\nThe counterpart of this tool is the ** [Arch Add](Arch_Add.md)** tool.\n\n \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 ** [Remove component](Arch_Remove.md)** button, or **Modify → 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 ** [Remove component](Arch_Remove.md)** button, or **Modify → 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"}
{"id": "freecad-docs:wiki/Arch_SelectNonSolidMeshes.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_SelectNonSolidMeshes.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_SelectNonSolidMeshes.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e68ddc5e7b708e26171e836b3f6831963c2ec3b97cb5fc8ce10192e48a1962c7", "bytes": 788, "tokens": 282, "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 [Mesh](Mesh_Workbench.md) objects.\n\n## Usage\n\n1. Select a mesh object.\n2. Select the **Utils → Select non-manifold meshes** option from the menu.\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch SelectNonSolidMeshes\n"}
{"id": "freecad-docs:wiki/Arch_ToggleSubs.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_ToggleSubs.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_ToggleSubs.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "15fb6ace02a98bab1e8d12f3f7b812f78ac5c4bacc6578cf82660ae97d689fae", "bytes": 1419, "tokens": 426, "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 → 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"}
{"id": "freecad-docs:wiki/Artwork_Mesh.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_Mesh.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_Mesh.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f33de5beb87941c36b3134f0913f93e7e82af48a409432a8ee1d8a4d41a7f127", "bytes": 3255, "tokens": 1374, "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 \n\n### src/Mod/Mesh/Gui/Resources/Icons/RegularSolids/\n\n \n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Mesh](Category_Mesh.md) > Artwork Mesh\n"}
{"id": "freecad-docs:wiki/Artwork_Part.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_Part.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_Part.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ea6efb27204f2f02903dc17f217b554df629e1e91900162291487dc5bd268a77", "bytes": 5401, "tokens": 2196, "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 \n\n### src/Mod/Part/Gui/Resources/icons/booleans\n\n \n\n### src/Mod/Part/Gui/Resources/icons/create\n\n \n\n### src/Mod/Part/Gui/Resources/icons/parametric\n\n \n\n### src/Mod/Part/Gui/Resources/icons/tools\n\n \n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Part](Category_Part.md) > Artwork Part\n"}
{"id": "freecad-docs:wiki/Artwork_Reinforcement.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_Reinforcement.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_Reinforcement.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0d336ec1420b640c33cad79719ae933c10a6e55fcaac12e09ccba24f48d40a39", "bytes": 522, "tokens": 205, "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"}
{"id": "freecad-docs:wiki/Artwork_ReverseEngineering.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_ReverseEngineering.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_ReverseEngineering.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "11039a2537c79a3d4d90ad40c08843ce289834acfd1746ac04c21fed049ba7b3", "bytes": 531, "tokens": 192, "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"}
{"id": "freecad-docs:wiki/Artwork_SheetMetal.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_SheetMetal.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_SheetMetal.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6b8b6243ccacd9e03bb62630edaabe8afe0913f029c2672216f2fb3976a340f6", "bytes": 1464, "tokens": 593, "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 \n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [SheetMetal](Category_SheetMetal.md) > Artwork SheetMetal\n"}
{"id": "freecad-docs:wiki/Assembly3_ConstraintSameOrientation.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_ConstraintSameOrientation.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_ConstraintSameOrientation.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1e5ae6c6d28c562f9d79fce1e96a8e74d82a1aa864b916ea84fd70e1aed8e3b4", "bytes": 1440, "tokens": 419, "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 [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 ** [Same orientation](Assembly3_ConstraintSameOrientation.md)** button.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintSameOrientation\n"}
{"id": "freecad-docs:wiki/Assembly3_CreateElement.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_CreateElement.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_CreateElement.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c6d095733b7ed7ea156bdf07424e7b3460d72a64165461453c82c004dfa88aba", "bytes": 1410, "tokens": 403, "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 [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 ** [Create element](Assembly3_CreateElement.md)** button.\n - Select the **Assembly3 → 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"}
{"id": "freecad-docs:wiki/Assembly3_ImportFromSTEP.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_ImportFromSTEP.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_ImportFromSTEP.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "15dcee103e7a708dbe401a895fcd42c1cf9fea98fe48b3515efa7f25353f3c23", "bytes": 1633, "tokens": 541, "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 [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 ** [Import from STEP](Assembly3_ImportFromSTEP.md)** button.\n - Press the down arrow of the ** '''Import as multi-document'''** button and select the ** Import from STEP** option from the dropdown.\n - Select the **Assembly3 → Import from STEP → Import from STEP** option from the menu.\n - Select the **Assembly → Import from STEP → 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"}
{"id": "freecad-docs:wiki/Assembly3_QuickSolve.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_QuickSolve.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_QuickSolve.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7ad3a8135d7a398cf2a539a72d2cbe1b2678a96e5ba173e62ffc9dc072b348ba", "bytes": 1332, "tokens": 462, "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 [Quick solve](Assembly3_QuickSolve.md) command starts the solver algorithm that relocates all objects of an assembly according to the constraints in the [Constraints container](Assembly3_CreateAssembly#Description.md).\n\n\n: (Here\\'s the space to put the differences to the [Resolve constraints](Assembly3_ResolveConstraints.md) command\\...)\n\n\n## Usage\n\n1. Activate the **Quick solve** command using one of the following:\n - The ** [Quick solve](Assembly3_QuickSolve.md)** button.\n - The **Assembly3 → Quick solve** menu option.\n - The keyboard shortcut: **A** then **F**.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 QuickSolve\n"}
{"id": "freecad-docs:wiki/Assembly_CreateJointParallel.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly_CreateJointParallel.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly_CreateJointParallel.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "939cb98ef135b89f6f6dd4fa4c6b18438c731b73ebdf0b65cfd0d8fe4df16221", "bytes": 1339, "tokens": 430, "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 [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 ** [Create Parallel Joint](Assembly_CreateJointParallel.md)** button.\n - Select the **Assembly → 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"}
{"id": "freecad-docs:wiki/BIM_Beam.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Beam.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Beam.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "fa177cd9dfbd293a66294d48373cb146cf92ed9eea5bab684c2c0dfe7dff6540", "bytes": 669, "tokens": 255, "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 ** [Beam](BIM_Beam.md)** button.\n - Select the **3D/BIM → 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"}
{"id": "freecad-docs:wiki/BIM_Clone.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Clone.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Clone.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "23e5b62e8b85e731112a801acbd0f992c254122b3c7ccf3bdfac5d689573d3fd", "bytes": 495, "tokens": 174, "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"}
{"id": "freecad-docs:wiki/BIM_Common.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Common.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Common.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2e1d5711eb97926dd0e968826b3ca0c34897836f9fdda027094a20c8bea2c8d2", "bytes": 142, "tokens": 61, "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"}
{"id": "freecad-docs:wiki/BIM_Diff.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Diff.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Diff.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7b99c565308f4fa6e1d20bbf6230d161256fe7d6362b118682f4d85a58b71ff6", "bytes": 1674, "tokens": 480, "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 \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 → 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"}
{"id": "freecad-docs:wiki/Basic_Part_Design_Tutorial.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Basic_Part_Design_Tutorial.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Basic_Part_Design_Tutorial.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6188f882a1e04a810f990a051d9ac5a1574aaf7250acd3f41500df31469fc7e2", "bytes": 18203, "tokens": 5099, "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: \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 [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 [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 \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 [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 ((v0.19) ), 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 [horizontal constraint](Sketcher_ConstrainHorizontal.md).\n2. Select the vertical line on the right and then click on the [vertical constraint](Sketcher_ConstrainVertical.md).\n3. Select the start and end points of your polyline and click on the [coincident constraint](Sketcher_ConstrainCoincident.md) to close the polyline.\n4. Select the bottom horizontal line and the right vertical line and apply and [equal constraint](Sketcher_ConstrainEqual.md).\n5. Select either the horizontal or vertical line and apply either a corresponding [horizontal distance constraint](Sketcher_ConstrainDistanceX.md) or [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 [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 [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: \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 [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 [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 [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 [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 [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: \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: \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: \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 [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 [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 [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 [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: \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"}
{"id": "freecad-docs:wiki/CAM_Copy.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_Copy.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_Copy.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "58bd544d4afacbff1142a0f83820003a7b3d40cacc9dcd09c0512aca35a61770", "bytes": 1018, "tokens": 362, "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 [Copy](CAM_Copy.md) creates a copy of a selected path.\n\n## Usage\n\n1. Select a [CAM](CAM_Workbench.md) object\n2. There are several ways to invoke the command:\n - Press the ** [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"}
{"id": "freecad-docs:wiki/CAM_Slot.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_Slot.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_Slot.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "296bc9033f6040f9e10effd9bbbfd4d7d9cfeee5923ef225d737b2eced63dedb", "bytes": 9564, "tokens": 2611, "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 [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 [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 ** [Slot](CAM_Slot.md)** button in the toolbar.\n\n#\\* Using the ** CAM** → ** [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 \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"}
{"id": "freecad-docs:wiki/CAM_Tools.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_Tools.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_Tools.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ce5d3a894252c4f2f0dba41dc3b1f10cb075edf53bafcdb646fa809ce78e0e39", "bytes": 9506, "tokens": 2673, "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- ** [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- ** [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 ** [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 [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 [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 [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"}
{"id": "freecad-docs:wiki/Category_EM.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_EM.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_EM.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e8a17a7d8412b117572c7db54070828b1e806b69ea9bfabb9ca23a63d0df89fb", "bytes": 719, "tokens": 323, "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"}
{"id": "freecad-docs:wiki/Category_External_Command_Reference.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_External_Command_Reference.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_External_Command_Reference.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "709f592a76ce112395b45939d0887bcfa60c705936c61e132d71272e64c2c469", "bytes": 6518, "tokens": 2810, "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"}
{"id": "freecad-docs:wiki/Category_Packaging.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Packaging.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Packaging.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e3b3ee23d41ba53361718205c5445742a9564c0e1db013bfc6ed3f5c1ee67525", "bytes": 840, "tokens": 307, "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"}
{"id": "freecad-docs:wiki/Category_Testing.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Testing.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Testing.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f0309d55b3f247ccb859cd69d959650318d9187dc4dda863886b4e90e9a03f75", "bytes": 537, "tokens": 195, "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"}
{"id": "freecad-docs:wiki/Continuous_Integration.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Continuous_Integration.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Continuous_Integration.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e0147da34f18f661c736ee14bc9a5ce8d03b30560a8174d37c31b41a2557f438", "bytes": 696, "tokens": 225, "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"}
{"id": "freecad-docs:wiki/Creating_a_simple_part_with_Part_WB.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Creating_a_simple_part_with_Part_WB.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Creating_a_simple_part_with_Part_WB.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f544216ddf12b992d50a5dc89559228e81839f586d008f38ce55febf4edd4214", "bytes": 29606, "tokens": 8269, "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 \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 [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 [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 **[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 **[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 **[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 **[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 **[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 **[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 **[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 **[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 **[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 [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 **[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 **[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 [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 **[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 **[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 **[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 **[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 [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, **[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"}
{"id": "freecad-docs:wiki/Dodo_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Dodo_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Dodo_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "48518e44fecdb3912503aecb33847e040459ba2ffdae6fb06b8c9d01d12fb7f6", "bytes": 214, "tokens": 85, "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"}
{"id": "freecad-docs:wiki/Draft_Pattern.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Pattern.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Pattern.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f997e20217e2e7e6e79d854d596491c99d4564387e763263e1b90bd419e3ee45", "bytes": 2594, "tokens": 911, "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"}
{"id": "freecad-docs:wiki/Draft_Slope.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Slope.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Slope.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1aa0f1fc70976fbfb46ebbd93eacb26a7c14b5827a4ebb505f7cf5d3748362a5", "bytes": 1994, "tokens": 675, "text": "---\n GuiCommand:\n Name: Draft Slope\n MenuLocation: Modification , Set slope Utils , Set slope\n Workbenches: Draft_Workbench, BIM_Workbench\n Version: 0.17\n---\n\n# Draft Slope\n\n## Description\n\nThe **Draft Slope** command slopes selected [Draft Lines](Draft_Line.md) or [Draft Wires](Draft_Wire.md) by increasing, or decreasing, the Z coordinate of all points after the first one. It can also be used to flatten [Draft Wires](Draft_Wire.md). Note that the slope is relative to the XY plane defined by the **Placement** of the objects.\n\n \n*On the left a horizontal Draft Line. On the right the same line with a slope value of 1 (angle is 45°)*\n\n## Usage\n\n1. Select one or more [Draft Lines](Draft_Line.md) and/or [Draft Wires](Draft_Wire.md).\n2. There are several ways to invoke the command:\n - [Draft](Draft_Workbench.md): Press the ** [Set slope](Draft_Slope.md)** button.\n - Draft: Select the **Modification → Set slope** option from the menu.\n - [BIM](BIM_Workbench.md): Select the **Utils → Set slope** option from the menu.\n3. Enter a **Slope** value. {{Value|0}} means each segment is horizontal, {{Value|0.5}} means the delta height for each segment is {{Value|0.5}} times its length, etc. The value can also be negative.\n4. Press **Enter** or the **OK** button to finish the command.\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThere is no Python method to slope objects. To emulate the results of the Draft Slope command the `Points` property of wire objects has to be modified.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Slope\n"}
{"id": "freecad-docs:wiki/Draft_Tray.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Tray.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Tray.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0240cee7e17d2c2a500256573a05ec04abd7def147505710077ff1b5deaf8d00", "bytes": 1286, "tokens": 448, "text": "# Draft Tray\n## Description\n\nThe **Draft Tray** allows selecting the working plane, defining style settings, toggling construction mode, and specifying the active layer or group. The four buttons show the current settings. The Draft Tray is available in the [Draft Workbench](Draft_Workbench.md) and the [BIM Workbench](BIM_Workbench.md) and cannot be disabled.\n\n  \n*The Draft Tray*\n\n## Available tools \n\n-  [Select Plane](Draft_SelectPlane.md): selects the current Draft working plane.\n\n-  [Set style](Draft_SetStyle.md): sets the default style for new objects.\n\n-  [Toggle construction mode](Draft_ToggleConstructionMode.md): switches Draft construction mode on or off.\n\n-  [AutoGroup](Draft_AutoGroup.md): changes the active [Draft Layer](Draft_Layer.md) or, optionally, the active [Std Group](Std_Group.md) or group-like [BIM](BIM_Workbench.md) object.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Tray\n"}
{"id": "freecad-docs:wiki/Draft_Trimex.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Trimex.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Trimex.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ebbde7a41db222a36ba0778104cbbe262673ac78b11f9dec64d5f8d3305bf0bc", "bytes": 5938, "tokens": 1897, "text": "---\n GuiCommand:\n Name: Draft Trimex\n MenuLocation: Modification , Trimex Modify , Trimex\n Workbenches: Draft_Workbench, BIM_Workbench\n Shortcut: **T** **R**\n SeeAlso: Part_Extrude\n---\n\n# Draft Trimex\n\n## Description\n\nThe **Draft Trimex** command [trims or extends](#Trim_or_extend.md) a selected object. Intersections with the edge of another object can be used to determine new endpoints. The command can also be used to [extrude](#Extrude.md) a face, in which case it creates a [Part Extrude](Part_Extrude.md) object.\n\n \n*Top: a Draft Wire extended and then trimmed. \nBottom: a face extruded into a solid body.*\n\n## Trim or extend \n\n### Usage\n\n1. Optionally select one object. The object must be a [Draft Line](Draft_Line.md), a [Draft Wire](Draft_Wire.md), a [Draft Arc](Draft_Arc.md) or a [Draft Circle](Draft_Circle.md) (which can only be trimmed). If the selected object is closed it must have its **Make Face** property set to `False`.\n2. There are several ways to invoke the command:\n - Press the ** [Trimex](Draft_Trimex.md)** button.\n - [Draft](Draft_Workbench.md): Select the **Modification → Trimex** option from the menu.\n - [BIM](BIM_Workbench.md): Select the **Modify → Trimex** option from the menu.\n - Use the keyboard shortcut: **T** then **R**.\n3. If you have not yet selected an object: select an object in the [3D view](3D_view.md).\n4. The **Trimex** task panel opens. See [Options](#Options.md) for more information.\n5. Move the pointer in the [3D view](3D_view.md) so that the preview matches the desired result. If required use the modifier keys as explained in the [Options](#Options.md).\n6. Do one of the following:\n - Pick a point in the [3D view](3D_view.md).\n - Enter a **Distance** or an **Angle**. The distance is a delta distance. This option does not work if modifier keys are used.\n - Move the pointer over an edge belonging to another object, and click when this edge is highlighted, to trim or extend the selected object using an intersection with the highlighted edge as the new endpoint. When trimming, the projection of the point where the cutting edge is selected onto the object to be trimmed, determines the default result. Note that [Draft Snaps](Draft_Snap.md) can have an undesirable impact here. In some cases it can be useful to turn them off temporarily.\n\n### Options\n\nThe single character keyboard shortcuts available in the task panel can be changed. See [Draft Preferences](Draft_Preferences.md). The shortcuts mentioned here are the default shortcuts.\n\n- Hold down **Alt** to invert the default result of the command.\n- Hold down **Shift** to restrict the operation to the current segment of a [Draft Wire](Draft_Wire.md).\n- Press **S** to switch [Draft snapping](Draft_Snap.md) on or off.\n\nHere is an example to explain the modifier keys. The left edge or the bottom edge of the U-shaped wire was extended. All [Draft Snaps](Draft_Snap.md) were turned off.\n\n  \n\n1. The arc was clicked near the bottom left corner of the wire. This is the default result.\n\n2. \n **Alt**was held down while the arc was clicked near the bottom left corner of the wire.\n\n3. \n **Y**was pressed, and while hovering over the left edge **Shift** was held down and then the arc was clicked. Pressing **Y** is only required for edges that are more or less parallel to the Y axis.\n\n## Extrude\n\n### Usage \n\nSee also: [Draft Snap](Draft_Snap.md) and [Draft Constrain](Draft_Constrain.md).\n\n1. It can be helpful to first change the [Draft working plane](Draft_SelectPlane.md) so that it is not coplanar with the face you want to extrude.\n2. Optionally select a single face or an object with a single face.\n3. There are several ways to invoke the command:\n - Press the ** [Draft Trimex](Draft_Trimex.md)** button.\n - Select the **Modification → Trimex** option from the menu.\n - Use the keyboard shortcut: **T** then **R**.\n4. If you have not yet selected an object or a face: select an object with a single face in the [3D view](3D_view.md).\n5. The **Trimex** task panel opens. See [Options](#Options_2.md) for more information.\n6. To define the extrusion direction and distance do one of the following:\n - Pick a point in the [3D view](3D_view.md) that does no lie on the same plane as the face.\n - Make sure the pointer is on the correct side of the face in the [3D view](3D_view.md) and enter a **Distance**.\n\n### Options \n\nThe modifier key mentioned here can be changed. See [Draft Preferences](Draft_Preferences.md).\n\n- Hold **Shift** to extrude in a direction that is not parallel to the normal of the face.\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThere is no Python method to trim objects. To extrude objects use the `extrude` method of the Draft module.\n\n \n```python\nextrusion = extrude(obj, vector, solid=False)\n```\n\n- `obj`is the object to be extruded.\n\n- `vector`is the extrusion direction and distance.\n\n- If `solid` is `True` a solid is created instead of a shell.\n\n- `extrusion`is returned with the created object.\n\nExample:\n\n \n```python\nimport FreeCAD as App\nimport Draft\n\ndoc = App.newDocument()\n\nrectangle = Draft.make_rectangle(1500, 500)\ndoc.recompute()\n\nvector = App.Vector(0, 0, 300)\nsolid = Draft.extrude(rectangle, vector, solid=True)\ndoc.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Trimex\n"}
{"id": "freecad-docs:wiki/Draft_WorkingPlane.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_WorkingPlane.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_WorkingPlane.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ba8aed59af9591a44b98801b0c00ec12310e54193686214ae858d0bce2c39c97", "bytes": 186, "tokens": 79, "text": "# Draft WorkingPlane\n1. REDIRECT [Draft_Snap_WorkingPlane](Draft_Snap_WorkingPlane.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft WorkingPlane\n"}
{"id": "freecad-docs:wiki/DynamicData_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/DynamicData_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/DynamicData_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "497a71def8070c60ed26b2608f30227a9b4e1f5d623adf94fa89291f39c72e21", "bytes": 2360, "tokens": 661, "text": "# DynamicData Workbench\n\n \n\n## Overview\n\nDynamicData is an [external workbench](External_workbenches.md) with which one can create a container object for holding custom properties.\n\nWith this workbench it\\'s possible to create a new custom [property](property.md) of just about any type that FreeCAD supports. For example a Length property or a [Placement](Placement.md) property. These custom properties can then be used in [Expressions](Expressions.md) just like any other property. For example, you could create a Length property called \\\"Width\\\" and refer to it when constraining a sketch element. Then when the \\\"Width\\\" property is changed, the sketch constraint will automatically update. This is similar to the way one can use a spreadsheet, but is more interactive in that the properties can be changed while still being able to see the [3D view](3D_view.md) and also allows for a wider variety of property types.\n\nSome features include:\n\n- ability to import named constraints from a sketch\n- ability to copy properties or set property values from one object to another\n- container objects remain compatible with FreeCAD installations that do not have the workbench installed\n\n## Installation\n\nThis workbench can be installed from the [Addon Manager](Std_AddonMgr.md). For manual installation see [Installing more workbenches](Installing_more_workbenches.md).\n\n## Links\n\n- Source code hosted on GitHub: [github.com](https://github.com/mwganson/DynamicData)\n- Official complete [documentation](https://github.com/mwganson/DynamicData/blob/master/README.md)\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) > DynamicData Workbench\n"}
{"id": "freecad-docs:wiki/FCGear_WormGear.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FCGear_WormGear.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FCGear_WormGear.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7b978dfeec27d313a2093c9d7d3f97fc7494207d134268e64a4746dd6636d66b", "bytes": 4975, "tokens": 1566, "text": "---\n GuiCommand:\n Name: FCGear WormGear\n MenuLocation: Gear , Worm Gear\n Workbenches: FCGear_Workbench\n Shortcut: None\n Version: v0.16\n SeeAlso: PartDesign_InvoluteGear\n---\n\n# FCGear WormGear\n\n## Description\n\nThe worm can be considered a special case of a helical gear. Imagine that there is only one tooth on a spur gear. Now increase the helix angle so much that the tooth winds around the spur gear several times before it emerges on the opposite side. The result would be a single thread worm.\n\nFor a single-start worm, each full turn (360 degrees) of the worm advances the gear by one tooth. So a gear with 24 teeth will provide a gear reduction of 24:1. For a multi-start worm, the gear reduction equals the number of teeth on the gear, divided by the number of starts on the worm.\n\nA worm can only be used with a worm wheel. This is called a worm drive. Like other gear arrangements, a worm drive can reduce rotational speed or transmit higher torque. One of the major advantages of worm gear drive units are that they can transfer motion in 90 degrees. A worm drive is also self-locking.\n\n  \n*Worm gear (No. of teeth 3)*\n\n## Usage\n\n1. Switch to the [FCGear Workbench](FCGear_Workbench.md).\n2. There are several ways to invoke the command:\n - Press the **[ [Worm Gear](FCGear_WormGear.md)** button in the toolbar.\n - Select the **Gear → [ Worm Gear** option from the menu.\n3. Change the gear parameter to the required conditions (see [Properties](#Properties.md)).\n\n## Properties\n\nAn FCGear WormGear object is derived from a [Part Feature](Part_Feature.md) object and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{Properties_Title|base}}\n\n- **diameter|Length**: Default is {{Value|5 mm}}. Pitch diameter.\n\n- **height|Length**: Default is {{Value|5 mm}}. Value of the worm length.\n\n- **module|Length**: Default is {{Value|1 mm}}. Module is the ratio of the reference diameter of the gear divided by the number of teeth (see [Notes](#Notes.md)).\n\n- **reverse_pitch|Bool**: Default is {{False}}, {{True}} changes the rotating direction from right to left.\n\n- **teeth|Integer**: Default is {{Value|3}}. Number of teeth (see [Notes](#Notes.md)).\n\n\n{{Properties_Title|computed}}\n\n- **beta|Angle**: (read-only) Lead angle (see also the information in [Notes](#Notes.md) and [Useful formulas](#Useful_formulas.md)).\n\n\n{{Properties_Title|involute}}\n\n- **pressure_angle|Angle**: Default is {{Value|20 °}} (see [Notes](#Notes.md)).\n\n\n{{Properties_Title|tolerance}}\n\n- **clearance|Float**: Default is {{Value|0.25}} (see [Notes](#Notes.md)).\n\n- **head|Float**: Default is {{Value|0}}. This value is used to change the tooth height.\n\n\n{{Properties_Title|version}}\n\n- **version|String**:\n\n## Notes\n\n- **beta**: If the lead angle is less than 5°, it is a self-locking gear. A typical example are the tuning pegs on a guitar or ukulele.\n\n- **clearance**: At a worm gearing, clearance is the distance between the tooth tip of the worm and the tooth root of the worm wheel.\n\n- **module**: Using ISO (International Organization for Standardization) guidelines, Module size is designated as the unit representing gear tooth-sizes. Module (m): m = 1 (p = 3.1416), m = 2 (p = 6.2832), m = 4 (p = 12.566). If you multiply Module by Pi, you can obtain Pitch (p). Pitch is the distance between corresponding points on adjacent teeth. If the module is changed, the lead angle also changes (**beta**).\n\n- **teeth**: The number of teeth in a worm is called the number of threads. Correspondingly, one speaks of single, double or multiple thread worms. In general, mainly single worms are produced, but in special cases the number of starts can be up to four (sometimes also more). If the number of teeth is changed, **beta** also changes.\n\n- **pressure_parameter**: Only change the parameter, if sufficient knowledge of the gear geometry is available.\n\n## Useful formulas \n\n- **beta (lead angle)**= arctan (**module** \\* **teeth** : **pitchdiameter (diameter)**)\n\n- **axial pitch**= **pi** \\* **module** \\* **teeth**\n\n- **beta (lead angle)**= arctan (**axial pitch** : (**pitchdiameter (diameter)** \\* **pi**))\n\n- **worm length**= 4,5 \\* **module** \\* **pi**\n\n## Worm wheel \n\nThe worm wheel must be designed manually. For this purpose [FCGear InvoluteGear](FCGear_InvoluteGear.md) can be used for a simple construction. In any case, in-depth knowledge of the gear types is required.\n\n  \n*Worm with worm wheel*\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [FCGear](Category_FCGear.md) > [External Command Reference](Category_External%20Command%20Reference.md) > FCGear WormGear\n"}
{"id": "freecad-docs:wiki/FEM_Analysis.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_Analysis.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_Analysis.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "da9ab64e5dcbb0dc08bd52e01e65416c7965d1f827447f250818e1d10bcde31d", "bytes": 2611, "tokens": 821, "text": "---\n GuiCommand:\n Name: FEM Analysis\n MenuLocation: Model , Analysis container\n Workbenches: FEM_Workbench\n Shortcut: **S** **A**\n SeeAlso: FEM_tutorial\n---\n\n# FEM Analysis\n\n## Description\n\nThe FEM Analysis could be seen as a container that holds all objects of a Finite Element Analysis. It is mandatory to have an analysis container that holds all the needed objects. At least one of the following objects (apart from the mesh) is necessary for a mechanical analysis:\n\n- [solid material](FEM_MaterialSolid.md),\n- [fixed boundary condition](FEM_ConstraintFixed.md) or [displacement boundary condition](FEM_ConstraintDisplacement.md) or [rigid body constraint](FEM_ConstraintRigidBody.md).\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Analysis container](FEM_Analysis.md)** button.\n - Select the **Model → Analysis container** option from the menu.\n - Use the keyboard shortcut: **S** then **A**.\n2. A new Analysis is created and set to active.\n3. Other objects could be added or removed from the analysis container by drag and drop.\n4. To add new FEM objects to the document the analysis has to be active. Double-clicking on the analysis container activates the analysis.\n\n## Options\n\n- Up to date there is no option to choose.\n\n## Properties\n\n- **OutpuDir**: Specifies the working directory of the analysis\n\n## Scripting\n\nmost code here is deprecated in 0.17.\n\n- new analysis\n\n \n```python\nMechanicalAnalysis.makeMechanicalAnalysis( name )\n```\n\n- add object to the analysis\n\n \n```python\nApp.ActiveDocument.MechanicalAnalysis.Member = App.ActiveDocument.MechanicalAnalysis.Member + [ (object) ]\n```\n\n- remove object from the analysis\n\n \n```python\nmember = App.ActiveDocument.MechanicalAnalysis.Member\nmember.remove( documentobject )\n App.ActiveDocument.MechanicalAnalysis.Member = member\n```\n\n Examples: \n```python\nimport MechanicalAnalysis\nanalysis = MechanicalAnalysis.makeMechanicalAnalysis(\"MechanicalAnalysis\")\nFemGui.setActiveAnalysis(analysis)\n\naddobj = App.ActiveDocument.getObject(\"MechanicalMaterial\")\nApp.ActiveDocument.MechanicalAnalysis.Member = App.ActiveDocument.MechanicalAnalysis.Member + [addobj]\n\nremoveobj = App.ActiveDocument.getObject(\"MechanicalMaterial\")\nmember = App.ActiveDocument.MechanicalAnalysis.Member\nmember.remove(removeobj)\nApp.ActiveDocument.MechanicalAnalysis.Member = member\n```\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM Analysis\n"}
{"id": "freecad-docs:wiki/FEM_ConstraintSpring.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_ConstraintSpring.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_ConstraintSpring.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "18251e1b17b25cfa75f059e4edd2650b7fceffc03f0bbbfadf6a2345cf16bf07", "bytes": 1491, "tokens": 527, "text": "---\n GuiCommand:Container|\n{{GuiCommand\n Name: FEM ConstraintSpring\n MenuLocation: Model , Mechanical boundary conditions and loads , Spring\n Workbenches: FEM_Workbench\n Shortcut: \n Version: 0.20\n SeeAlso: \n}}\n{{GuiCommandFemInfo\n Solvers: Elmer\n}}\n---\n\n# FEM ConstraintSpring\n\n## Description\n\nDefines a spring boundary condition to be used for mechanical analyses using the [Elmer solver](FEM_SolverElmer.md).\n\n\n(v0.21) \n\n: The spring constraint can be used for the equations [Deformation](FEM_EquationDeformation.md) and [Elasticity](FEM_EquationElasticity.md).\n\n## Usage\n\n1. Either use the toolbar button ** [Spring](FEM_ConstraintSpring.md)** or the menu **Model → Mechanical boundary conditions and loads → Spring**.\n2. Press the **Add** button.\n3. In the [3D view](3D_view.md) select the faces to which the spring should be applied. To remove faces from the selection, press the **Remove** button and click on them.\n4. Specify the normal or tangential stiffness (in N/m) and select which one Elmer should use.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM ConstraintSpring\n"}
{"id": "freecad-docs:wiki/FEM_Examples.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_Examples.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_Examples.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6ff655292a745bf251399c7c069cbd6851ef565a6aa25e75bfacb288ba27a200", "bytes": 1381, "tokens": 457, "text": "---\n GuiCommand:\n Name: FEM Examples\n MenuLocation: Utilities , Open FEM examples\n Workbenches: FEM_Workbench\n Version: 0.19\n SeeAlso: FEM_tutorial\n---\n\n# FEM Examples\n\n## Description\n\n[FEM Examples](FEM_Examples.md) launches a graphical interface that allows you to access the different examples available in the [FEM](FEM_Workbench.md) workbench.\n\n  \n*The example selection dialog*\n\n## Usage\n\n1. The examples will use one of the [finite element solvers](FEM_Solver.md) that the workbench supports. Therefore the necessary [FEM solver](FEM_Solver.md) must be installed before they can be run.\n2. Select the **Utilities → Open FEM examples** option from the menu or press the ** [Open FEM examples](FEM_Examples.md)** button.\n3. The **FEM Examples** view opens with various categories, **All**, **Constraints**, **Equations**, **Materials**, **Meshes**, **Solvers**.\n4. Open the categories, select one example, and press **Setup** to open the simulation case only.\n5. Or press **Run** to open the case, and start the simulation, so that the results are available.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM Examples\n"}
{"id": "freecad-docs:wiki/FEM_SolverCalculiX.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_SolverCalculiX.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_SolverCalculiX.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4532096c9f4f8c1e95deb5b12f3cf469557e5f1b6c384b428c108e9b32e43789", "bytes": 970, "tokens": 344, "text": "---\n GuiCommand:\n Name: FEM SolverCalculiX\n MenuLocation: Solve , Solver CalculiX \n Workbenches: FEM_Workbench\n Shortcut: **S** **C**\n---\n\n# FEM SolverCalculiX\n\n## Description\n\nThe **Solver CalculiX (new framework)** command creates a SolverCalculix object, which uses the same framework as Elmer and Z88 solvers (the code is not visible for the user). It is preferred to use the original framework [Solver CalculiX Standard](FEM_SolverCalculixCxxtools.md) because it contains extra checks, e.g. showing the elements with nonpositive Jacobian which might cause solution difficulties.\n\n## Usage\n\n1. Select **Solve → Solver CalculiX (new framework)** from the menu.\n\n## Related\n\n- [FEM CalculiX](FEM_CalculiX.md)\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM SolverCalculiX\n"}
{"id": "freecad-docs:wiki/Fasteners_BOM.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Fasteners_BOM.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Fasteners_BOM.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "5e600259eff044a094911c29e1dc6901fb8ba6625c48dea35975f25c35f95dfb", "bytes": 1330, "tokens": 484, "text": "---\n GuiCommand:\n Name: Fasteners BOM\n MenuLocation: Fasteners , Generate BOM\n Workbenches: Fasteners_Workbench\n SeeAlso: Spreadsheet_Workbench\n---\n\n# Fasteners BOM\n\n## Description\n\nThe **Fasteners BOM** command creates a spreadsheet with a bill of materials (BOM) for the fasteners in the document.\n\n \n*A model with a Fasteners BOM spreadsheet*\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Generate BOM](Fasteners_BOM.md)** button.\n - Select the **Fasteners → Generate BOM** option from the menu.\n2. A Fasteners BOM spreadsheet is created.\n\n## Notes\n\n- A Fasteners BOM spreadsheet does not update if fasteners are changed, or if fasteners are added or removed. In such cases the command has to be used to create a new spreadsheet.\n- A Fasteners BOM spreadsheet can be exported with the [Spreadsheet Export](Spreadsheet_Export.md) command.\n\n\n {{Fasteners_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [External_Command_Reference](Category_External_Command_Reference.md) > [Fasteners](Category_Fasteners.md) > Fasteners BOM\n"}
{"id": "freecad-docs:wiki/Fasteners_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Fasteners_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Fasteners_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2b9b13f0b02322bd6f158bf8251ed84ec547d4a02cd0a634cf32737fe22bac6a", "bytes": 33305, "tokens": 13597, "text": "# Fasteners Workbench\n\n \n\n## Introduction\n\nThe [Fasteners Workbench](Fasteners_Workbench.md) is an [external workbench](External_workbenches.md) that can add various fasteners to parts.\n\n \n*The optional single toolbar layout of the workbench. \nFasteners with metric dimensions have orange icons. \nFasteners with inch dimensions have green icons.*\n\n## Installation\n\n1. Install the Fasteners Workbench via the [Addon Manager](Std_AddonMgr.md). For manual installation see [Installing more workbenches](Installing_more_workbenches.md).\n2. Restart FreeCAD.\n3. Select the [Fasteners Workbench](Fasteners_Workbench.md) from the [Workbench dropdown list](Std_Workbench.md).\n4. Optionally change the toolbar and menu layout:\n 1. Go to: **Edit → Preferences... → Fasteners → General settings**.\n 2. Select one of the available **Toolbar screw icons grouping** options:\n - \n **None**\n \n : All fasteners appear in a single toolbar. To see all available buttons use the **>>** button to expand it.\n\n - \n **Separate toolbars**\n \n : Fasteners are grouped in several toolbars. This is the default layout.\n\n - \n **Dropdown buttons**\n \n : Fasteners are grouped in toolbars with flyouts.\n 3. Optionally uncheck one or more **Fastener standards shown in toolbars** options. Unchecked standards are still available from the menu.\n 4. Restart FreeCAD.\n\n## Usage\n\nFasteners can be attached or unattached. Attached fasteners have a **Base Object**, a circular edge, and their **Placement** is dynamically linked to that object. The [Fasteners Move](Fasteners_Move.md) command can be used to attach or detach a fastener.\n\n### Unattached fasteners \n\n1. Select the desired fastener by clicking its button or by picking it from the menu.\n2. A fastener is created at the origin.\n3. Optionally change the dimensions and other properties of the fastener:\n 1. Select the fastener.\n 2. Go to the **Data** tab of the [Property editor](Property_editor.md).\n 3. Change the required properties.\n\n### Attached fasteners \n\n \n*On the left two selected circular edges. On the right the attached fasteners.*\n\n1. Specify if the selected holes are tap holes or pass holes by selecting [Fasteners MatchTypeInner](Fasteners_MatchTypeInner.md) or [Fasteners MatchTypeOuter](Fasteners_MatchTypeOuter.md) respectively (not used for countersunk screws).\n2. Select one or more circular edges and/or faces with circular edges. For countersunk screws the top edge of the chamfered hole must be selected.\n3. Select the desired fastener by clicking its button or by picking it from the menu.\n4. A fastener is attached to each of the selected circular edges.\n5. The default dimensions of each fastener depend on the radius of the circular edge it is attached to. Countersunk screws are matched by their head diameter, other fasteners are matched by their shaft diameter.\n6. Optionally change the dimensions and other properties of the fasteners. See above.\n7. Fasteners that appear upside-down can be inverted with the [Fasteners Flip](Fasteners_Flip.md) command or by changing their **Invert** property.\n8. Optionally change the **Offset** property to create space between the fasteners and the edges they are attached to.\n\n## Notes\n\n- To generate threads, the **Thread** property of a fastener must be changed to `True`. Generating threads is costly. Recomputes take much longer if there are many fasteners with threads in a document.\n- The **Invert** property and the **Offset** property are ignored for unattached fasteners.\n\n## Commands\n\n- [Invert fastener](Fasteners_Flip.md): Invert the orientation of attached fasteners.\n\n- [Move fastener](Fasteners_Move.md): Move and attach a fastener to a circular edge. Can also be used to detach a fastener.\n\n- [Simplify shape](Fasteners_Simplify.md): Create non-parametric copies of fasteners.\n\n- [Match for tap hole](Fasteners_MatchTypeInner.md): Consider circular edges to be tap holes when new fasteners are attached to them.\n\n- [Match for pass hole](Fasteners_MatchTypeOuter.md): Consider circular edges to be pass holes when new fasteners are attached to them.\n\n- [Generate BOM](Fasteners_BOM.md): Create a spreadsheet with a bill of materials for the fasteners in the document.\n\n- [Screw calculator](Fasteners_ScrewCalculator.md): Show a calculator to determine the tap hole size of screws.\n\n- [Change fastener parameters](Fasteners_ChangeParameters.md): Change the parameters of fasteners.\n\n## Fasteners\n\nFasteners with metric dimensions have orange icons. Fasteners with inch dimensions have green icons.\n\n### Hexagon head screws and bolts \n\n- **ASME B18.2.1.6** UNC hexagon head screw.\n\n- **ASME B18.2.1.8** UNC hexagon head screw with flange.\n\n- **DIN 571** Hexagon head wood screw.\n\n- **DIN 933** Hexagon head screw.\n\n- **DIN 961** Hexagon head screw.\n\n- **EN 1662** Hexagon head bolt with flange, small series.\n\n- **EN 1665** Hexagon head bolt with flange, heavy series.\n\n- \n**ISO 4014** Hexagon head bolt. *Product grades A and B.*\n\n- **ISO 4015** Hexagon head bolt with reduced shank.\n\n- \n**ISO 4016** Hexagon head bolt. *Product grade C.*\n\n- \n**ISO 4017** Hexagon head screw. *Product grades A and B.*\n\n- \n**ISO 4018** Hexagon head screw. *Product grade C.*\n\n- \n**ISO 4162** Hexagon bolt with flange, small series. *Product grade A with driving feature of product grade B.*\n\n- \n**ISO 8676** Hexagon head screw with fine pitch thread. *Product grades A and B.*\n\n- **ISO 8765** Hexagon head bolt with fine pitch thread.\n\n- \n**ISO 15071** Hexagon bolt with flange, small series. *Product grade A.*\n\n- \n**ISO 15072** Hexagon bolt with flange and fine pitch thread, small series. *Product grade A.*\n\n### Hexagon socket screws \n\n- **ASME B18.3.1A** UNC hexagon socket head cap screw.\n\n- **ASME B18.3.1G** UNC hexagon socket head cap screw with low head.\n\n- **ASME B18.3.2** UNC hexagon socket countersunk head screw.\n\n- **ASME B18.3.3A** UNC hexagon socket button head screw.\n\n- **ASME B18.3.3B** UNC hexagon socket button head screw with flange.\n\n- **ASME B18.3.4** UNC hexagon socket head shoulder screw.\n\n- **DIN 6912** Hexagon socket head cap screw with low head with center.\n\n- **DIN 7984** Hexagon socket head cap screw with low head.\n\n- **ISO 2936** Hexagon socket screw key.\n\n- **ISO 4762** Hexagon socket head cap screw.\n\n- **ISO 7379** Hexagon socket head shoulder screw.\n\n- **ISO 7380-1** Hexagon socket button head screw.\n\n- **ISO 7380-2** Hexagon socket button head screw with flange.\n\n- **ISO 10642** Hexagon socket countersunk head screw.\n\n### Hexalobular socket head screws \n\n- **ISO 14579** Hexalobular socket head cap screw.\n\n- **ISO 14580** Hexalobular socket cheese head screw.\n\n- **ISO 14581** Hexalobular socket countersunk flat head screw.\n\n- **ISO 14582** Hexalobular socket countersunk head screw, high head.\n\n- **ISO 14583** Hexalobular socket pan head screw.\n\n- **ISO 14584** Hexalobular socket raised countersunk head screw.\n\n### Slotted head screws \n\n- **ASME B18.6.1.2** Slotted flat countersunk head wood screw.\n\n- **ASME B18.6.1.4** Slotted oval countersunk head wood screw.\n\n- **ASME B18.6.3.1A** UNC slotted countersunk flat head screw.\n\n- **ASME B18.6.3.4A** UNC slotted oval countersunk head screw.\n\n- **ASME B18.6.3.9A** UNC slotted pan head screw.\n\n- **ASME B18.6.3.10A** UNC Slotted fillister head screw.\n\n- **ASME B18.6.3.12A** UNC Slotted truss head screws.\n\n- **ASME B18.6.3.16A** UNC Slotted round head screw.\n\n- \n**DIN 84 (superseded by ISO 1207)** Slotted cheese head screw. *Product grade A.*\n\n- **DIN 96** Slotted half round head wood screw.\n\n- **GOST 1144-1** Slotted half round head wood screw.\n\n- **GOST 1144-2** Slotted half round head wood screw.\n\n- \n**ISO 1207** Slotted cheese head screw. *Product grade A.*\n\n- \n**ISO 1580** Slotted pan head screw. *Product grade A.*\n\n- \n**ISO 2009** Slotted countersunk flat head screw. *Product grade A.*\n\n- \n**ISO 2010** Slotted raised countersunk head screw. *Product grade A.*\n\n### H cross head screws \n\n- **ASME B18.6.1.3** Flat countersunk head wood screw.\n\n- **ASME B18.6.1.5** Oval countersunk head wood screw.\n\n- **ASME B18.6.3.1B** UNC flat countersunk head screw.\n\n- **ASME B18.6.3.4B** UNC oval countersunk head screw.\n\n- **ASME B18.6.3.9B** UNC pan head screw.\n\n- **ASME B18.6.3.10B** UNC fillister head screw.\n\n- **ASME B18.6.3.12C** UNC truss head screws.\n\n- **ASME B18.6.3.16B** UNC round head screw.\n\n- **DIN 967** Pan head screw with collar.\n\n- **DIN 7996** Pan head wood screw.\n\n- **GOST 1144-3** Pan head wood screw.\n\n- **GOST 1144-4** Pan head wood screw.\n\n- \n**ISO 7045** Pan head screw. *Product grade A.*\n\n- \n**ISO 7046** Countersunk flat head screw. *Product grade A.*\n\n- \n**ISO 7047** Raised countersunk head screw. *Product grade A.*\n\n- **ISO 7048** Cheese head screw.\n\n- **ISO 7049-C** Pan head self tapping screws with conical point.\n\n- **ISO 7049-F** Pan head self tapping screws with flat point.\n\n- **ISO 7049-R** Pan head self tapping screws with rounded point.\n\n### Other head bolts \n\n- **ASME B18.2.1.1** UNC square head bolt.\n\n- **ASME B18.5** UNC Round head square neck bolt.\n\n- **DIN 478** Square head bolt with collar.\n\n- **DIN 603** Round head square neck bolt.\n\n- **ISO 2342** Headless screw with shank\n\n### Set screws \n\n- **ASME B18.3.5A** UNC hexagon socket set screw with flat point.\n\n- **ASME B18.3.5B** UNC hexagon socket set screw with cone point.\n\n- **ASME B18.3.5C** UNC hexagon socket set screw with dog point.\n\n- **ASME B18.3.5D** UNC hexagon socket set screw with cup point.\n\n- **ISO 4026** Hexagon socket set screw with flat point.\n\n- **ISO 4027** Hexagon socket set screw with cone point.\n\n- **ISO 4028** Hexagon socket set screw with dog point.\n\n- **ISO 4029** Hexagon socket set screw with cup point.\n\n- **ISO 4766** Slotted socket set screw with flat point.\n\n- **ISO 7434** Slotted socket set screw with cone point.\n\n- **ISO 7435** Slotted socket set screw with long dog point.\n\n- **ISO 7436** Slotted socket set screw with cup point.\n\n### Thumb screws \n\n- **DIN 464** Knurled thumb screw, high type.\n\n- **DIN 465** Slotted knurled thumb screw, high type.\n\n- **DIN 653** Knurled thumb screw, low type.\n\n### Nuts\n\n- **ASME B18.2.2.1A** UNC hexagon machine screw nut.\n\n- **ASME B18.2.2.1B** UNC square machine screw nut.\n\n- **ASME 18.2.2.2** UNC square nut.\n\n- **ASME B18.2.2.4A** UNC hexagon nut.\n\n- **ASME B18.2.2.4B** UNC hexagon thin nut.\n\n- **ASME 18.2.2.5** UNC hexagon castle nut.\n\n- **ASME 18.2.2.12** UNC hexagon nut with flange.\n\n- **ASME 18.2.2.13** UNC hexagon coupling nut.\n\n- **ASME 18.6.9A** Wing nut, type A.\n\n- **DIN 315** Wing nut.\n\n- **DIN 557** Square nut.\n\n- **DIN 562** Square nut.\n\n- **DIN 917** Cap nut, low form.\n\n- **DIN 928** Square weld nut.\n\n- **DIN 929** Hexagon weld nut.\n\n- \n**DIN 934 (superseded by ISO 4035 and ISO 8673)** Hexagon thin nut chamfered. *Product grades A and B.*\n\n- **DIN 935** Hexagon castle nut.\n\n- **DIN 985** Nyloc nut.\n\n- **DIN 1587** Cap nut.\n\n- **DIN 6330** Hexagon nut 1.5d high.\n\n- **DIN 6331** Hexagon with collar 1.5d high.\n\n- **DIN 6334** Hexagon coupling nut.\n\n- **DIN 7967** Self-locking counter nut.\n\n- **EN 1661** Hexagon nut with flange.\n\n- **GOST 11860-1** Cap nut.\n\n- \n**ISO 4032** Hexagon nut, style 1. *Product grades A and B.*\n\n- \n**ISO 4033** Hexagon high nut, style 2. *Product grades A and B.*\n\n- **ISO 4034** Hexagon nut, style 1.\n\n- \n**ISO 4035** Hexagon thin nut chamfered, style 0. *Product grades A and B.*\n\n- **ISO 4161** Hexagon nut with flange.\n\n- **ISO 7040** Prevailing torque type hexagon nut (with non-metallic insert).\n\n- **ISO 7041** Prevailing torque type hexagon nut (with non-metallic insert), style 2.\n\n- **ISO 7043** Prevailing torque type hexagon nut with flange (with non-metallic insert).\n\n- **ISO 7044** Prevailing torque type all-metal hexagon nut with flange.\n\n- **ISO 7719** Prevailing torque type all-metal hexagon nut.\n\n- **ISO 7720** Prevailing torque type all-metal hexagon nut, style 2.\n\n- \n**ISO 8673** Hexagon nut with fine pitch thread, style 1. *Product grades A and B.*\n\n- \n**ISO 8674** Hexagon high nut with fine pitch thread, style 2. *Product grades A and B.*\n\n- \n**ISO 8675** Hexagon thin nut with fine pitch thread, style 0. *Product grades A and B.*\n\n- **ISO 10511** Prevailing torque type hexagon thin nut (with non-metallic insert).\n\n- **ISO 10512** Prevailing torque type hexagon nut with fine pitch thread (with non-metallic insert).\n\n- **ISO 10513** Prevailing torque type all-metal hexagon nut with fine pitch thread.\n\n- **ISO 10663** Hexagon nut with flange and fine pitch thread.\n\n- **ISO 12125** Prevailing torque type hexagon nut with flange and fine pitch thread (with non-metallic insert).\n\n- **ISO 12126** Prevailing torque type all-metal hexagon nut with flange and fine pitch thread.\n\n- **ISO 21670** Hexagon weld nut with flange.\n\n- **SAE J483a 1** Low cap nut.\n\n- **SAE J483a 2** High cap nut.\n\n### T-slot fasteners \n\n- **DIN 508** T-slot nut.\n\n- **GN 505** Serrated quarter-turn T-slot nut.\n\n- **GN 505.4** Serrated T-slot bolt.\n\n- **GN 506** T-Slot swivel nut.\n\n- **GN 507** T-slot nut.\n\n- **ISO 299** T-Slot nut.\n\n### Washers\n\n- **ASME B18.21.1.12A** UN washer, narrow series.\n\n- **ASME B18.21.1.12B** UN washer, regular series.\n\n- **ASME B18.21.1.12C** UN washer, wide series.\n\n- **DIN 6319C** Spherical washer.\n\n- **DIN 6319D** Conical seat.\n\n- **DIN 6319G** Conical seat.\n\n- **DIN 6340** Washer for clamping devices.\n\n- \n**ISO 7089** Plain washer, normal series. *Product grade A.*\n\n- \n**ISO 7090** Plain washer chamfered, normal series. *Product grade A.*\n\n- \n**ISO 7092** Plain washer, small series. *Product grade A.*\n\n- \n**ISO 7093-1** Plain washer, large series. *Product grade A.*\n\n- \n**ISO 7094** Plain washer, extra large series. *Product grade C.*\n\n- **ISO 8738** Plain washer for clevis pins.\n\n- **NFE27-619** Countersunk washer.\n\n### Rods, taps and dies \n\n- Inch threaded rod for tapping holes.\n\n- Tool object for cutting external inch threads.\n\n- UNC inch threaded rod.\n\n- DIN 975 metric threaded rod.\n\n- Metric threaded rod for tapping holes.\n\n- Tool object for cutting external metric threads.\n\n### Inserts\n\n- Heat staked insert.\n\n- Self-clinching nut.\n\n- Self-clinching standoff.\n\n- Self-clinching stud.\n\n- PCB spacer female/female.\n\n- PCB standoff female/male.\n\n- 4 prong threaded wood insert (DIN 1624 Tee nuts).\n\n### Retaining rings \n\n- **DIN 471** External retaining ring.\n\n- **DIN 472** Internal retaining ring.\n\n- **DIN 6799** E-clip retaining ring.\n\n### Nails\n\n- **DIN 1143** Round plain head nail for use in automatic nailing machines.\n\n- **DIN 1144-A** Nail for the installation of wood wool composite panels, 20mm round head.\n\n- **DIN 1151-A** Round plain head wire nail.\n\n- **DIN 1151-B** Round countersunk head wire nail.\n\n- **DIN 1152** Round lost head wire nail.\n\n- **DIN 1160-A** Clout or slate nail.\n\n- **DIN 1160-B** Clout or slate wide head nail.\n\n### Pins\n\n- **ISO 1234** Split pin.\n\n- **ISO 2338** Parallel pin.\n\n- **ISO 2339** Taper pin.\n\n- **ISO 2340A** Clevis pin.\n\n- **ISO 2340B** Clevis pin without head (with split pin holes).\n\n- **ISO 2341A** Clevis pin with head.\n\n- **ISO 2341B** Clevis pin with head (with split pin hole).\n\n- **ISO 8733** Parallel pin with internal thread, unhardened.\n\n- **ISO 8734** Dowel pin.\n\n- **ISO 8735** Parallel pin with internal thread, hardened.\n\n- **ISO 8736** Taper pin with internal thread, unhardened.\n\n- **ISO 8737** Taper pin with external thread, unhardened.\n\n- **ISO 8739** Full-length grooved pin with pilot.\n\n- **ISO 8740** Full-length grooved pin with chamfer.\n\n- **ISO 8741** Half-length reverse taper grooved pin.\n\n- **ISO 8742** Third-length center grooved pin.\n\n- **ISO 8743** Half-length center grooved pin.\n\n- **ISO 8744** Full-length taper grooved pin.\n\n- **ISO 8745** Half-length taper grooved pin.\n\n- **ISO 8746** Grooved pin with round head.\n\n- **ISO 8747** Grooved pin with countersunk head.\n\n- **ISO 8748** Coiled spring pin, heavy duty.\n\n- **ISO 8750** Coiled spring pin, standard duty.\n\n- **ISO 8751** Coiled spring pin, light duty.\n\n- **ISO 8752** Slotted spring pin, heavy duty.\n\n- **ISO 13337** Slotted spring pin, light duty.\n\n## Obsolete\n\n- [Make countersunk](Fasteners_ChamferHole.md): Chamfer holes for countersunk screws. Not available in (v0.5.13) .\n\n## References\n\n- Author: [shaise](http://theseger.com/projects/author/shaise/)\n - ScrewMaker: Ulrich Brammer\n - Workbench wrapper: Shai Seger\n- Source code: \n- Bug reports and feature requests: \n- Forum topic: \n\n## Links\n\n- [BOLTS](https://github.com/jreinhardt/BOLTS): An open library for technical specifications.\n\n {{Fasteners_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [User_Documentation](Category_User_Documentation.md) > [External_Workbenches](Category_External_Workbenches.md) > [Fasteners](Category_Fasteners.md) > Fasteners Workbench\n"}
{"id": "freecad-docs:wiki/Flamingo.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Flamingo.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Flamingo.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "33adae79db5758d76fadc3643d95d25eb8129acc14d69698bdeff7935a3b7702", "bytes": 126, "tokens": 58, "text": "# Flamingo\n1. REDIRECT [Flamingo Workbench](Flamingo_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > Flamingo\n"}
{"id": "freecad-docs:wiki/FreeCAD_Docker_CLI_mode.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FreeCAD_Docker_CLI_mode.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FreeCAD_Docker_CLI_mode.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b37e1cd9b8508b5a69c1d2f76651de96ad75befc0a93a1dbcc5d6b111f9228cf", "bytes": 1960, "tokens": 684, "text": "# FreeCAD Docker CLI mode\n## Overview\n\nDocker image of FreeCAD compiled without GUI. This Docker image is especially for developers who only want to use FreeCAD in the command-line interface (CLI).\n\n### Benefits\n\nAll of FreeCAD\\'s dependencies are already installed, compatible with each other, and configured appropriately, allowing you to get started developing very quickly.\n\n- Easy to use and lightweight.\n- It gives better performance in terms of speed.\n- No need to add FreeCAD paths to import it into Python.\n\n## Docker Repository \n\n- Docker Hub: \n- Github repository: \n\n## Prerequisites\n\n- 3 GB of free storage\n- Docker\n\n## Installation\n\n1. Pull the Docker image.{{Code|lang=bash|code=\n docker pull amrit3701/freecad-cli:latest\n }}\n\n\n1. When you successfully pulled Docker image, now you can run image.{{Code|lang=bash|code=\n docker run -it amrit3701/freecad-cli:lastest bash\n }}\n\n\n## Additional information \n\n### Extend Docker image \n\nYou can also extend this Docker images to add additional dependencies for your project. For eg {{Code|lang=docker|code=\n\n# Dockerfile\n\nFROM amrit3701/freecad-cli:lastest\n\n# Add additional dependencies\n\n# pip3.8 install \n}}\n\n### Import FreeCAD in Python \n\nAfter running Docker image, just run \n\n\n{{Code|lang=bash|code=\n$ docker run -it amrit3701/freecad-cli:lastest bash\nroot@f0ec904cf9b9:/# python3.8\nPython 3.8.5 (default, Jul 20 2020, 19:48:14)\n[GCC 7.5.0] on linux\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n>>> import FreeCAD\n>>> import Part\n>>> import Draft\n>>> import Arch\n}}\n\n\n### Launch FreeCADCmd \n\nTo launch FreeCAD inside Docker image, just run FreeCADCmd command.\n\n## Discussion\n\nFreeCAD forum thread: \n\n\n---\n⏵ [documentation index](../README.md) > FreeCAD Docker CLI mode\n"}
{"id": "freecad-docs:wiki/GitHub.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/GitHub.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/GitHub.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0c870e1bd7c022e1f86f9e7658afb28ed7dcbedc9b3c0024b993f8b14defed6a", "bytes": 130, "tokens": 51, "text": "# GitHub\n1. REDIRECT [Source_code_management](Source_code_management.md)\n\n\n---\n⏵ [documentation index](../README.md) > GitHub\n"}
{"id": "freecad-docs:wiki/How_to_install_macros.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/How_to_install_macros.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/How_to_install_macros.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bf001c65264a2cf73ff94e4efb6781058a7d0d81a2fe01d7f92c5a70577805f3", "bytes": 19930, "tokens": 6650, "text": "---\n TutorialInfo:\n Topic: Programming\n Level: Medium programmer\n Time: 15 minutes\n FCVersion: All\n Author: User:Mario52\n---\n\n# How to install macros\n\n \n\n\n## Description\n\nSince v0.17 it is easy to add macros by using the [Addon Manager](Std_AddonMgr.md). A regular user doesn\\'t need to do more than use this tool. Keep reading for more information regarding installation of [macros](macros.md).\n\nMacros are sequences of commands which are used to perform a complex drawing operation. Macros are [Python](Python.md) scripts, which means they are text files that can be written and edited with a text editor.\n\nWhile Python scripts normally have the `.py` extension, FreeCAD macros should have the `.FCMacro` extension. A collection of macros written by experienced users is found in the [macros recipes](macros_recipes.md) page.\n\nSee [Introduction to Python](Introduction_to_Python.md) to learn about the Python programming language, and then [Python scripting tutorial](Python_scripting_tutorial.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md) to learn about writing macros.\n\nHere is a video on [installing FreeCAD macros in Ubuntu](https://wiki.opensourceecology.org/wiki/Installing_Macros_in_FreeCAD).\n\n## The Macro menu and toolbar \n\n### Toolbar\n\n- [Macro recording\\...](Std_DlgMacroRecord.md)\n- [Stop macro recording](Std_MacroStopRecord.md)\n- [Macros\\...](Std_DlgMacroExecute.md)\n- [Execute macro](Std_DlgMacroExecuteDirect.md)\n\n### Menu\n\nBesides the tools in the toolbar, the following functions are also available in the **Macro** menu.\n\n- [Attach to remote debugger](Std_MacroAttachDebugger.md)\n- [Debug macro](Std_MacroStartDebug.md)\n- [Stop debugging](Std_MacroStopDebug.md)\n- [Step over](Std_MacroStepOver.md)\n- [Step into](Std_MacroStepInto.md)\n- [Toggle breakpoint](Std_ToggleBreakpoint.md)\n\n## Macros directory \n\n\n
\n\n\nMacros are created in a specific folder under the user\\'s FreeCAD directory. This directory can be configured in the [Execute macro dialog](Std_DlgMacroExecute.md), or in the [Preferences Editor](Preferences_Editor.md), through the menu **Edit → Preferences → Python → Macro → Macro recording settings**.\n\nDownloaded macros should also be placed in this directory.\n\n\n
\n\n\n### Default directory \n\nMacros can be simply copied into\n\n \n```python\n$ROOT_DIR/\n```\n\nwhere `$ROOT_DIR` is a top level directory searched by FreeCAD on startup.\n\nThe `$ROOT_DIR` could be a system wide directory, in which case the macro is installed for all users.\n\n- On Linux it is usually `/usr/share/freecad/`\n- On Windows it is usually `C:\\Program Files\\FreeCAD\\`\n- On Mac OSX it is usually `/Applications/FreeCAD/`\n\nThe `$ROOT_DIR` could be a particular user\\'s directory.\n\n- On Linux it is usually `/home/username/.local/share/FreeCAD/` ((v0.20) ) or `/home/username/.FreeCAD/` ({{VersionMinus|0.19}}).\n- On Windows it is usually `C:\\Users\\username\\AppData\\FreeCAD\\`\n- On Mac OSX it is usually `/Users/username/Library/Preferences/FreeCAD/`\n\n### Configuring the user directory \n\n1\\. Open the menu **Macro → [Macros...](Std_DlgMacroExecute.md)** to open the [Execute macro dialog](Std_DlgMacroExecute.md).\n\n \n*align=center|Opening the Execute macro dialog*\n\n2\\. Set the appropriate `User macros location`.\n\n- Linux: usually `/home/username/.local/share/FreeCAD/` ((v0.20) ) or `/home/username/.FreeCAD/` ({{VersionMinus|0.19}})\n- Windows: usually `C:\\Users\\username\\AppData\\Roaming\\FreeCAD\\`\n- MacOS: usually `/Users/username/Library/Preferences/FreeCAD/`\n\n \n*align=center|Setting of the macros directory*\n\n3\\. Navigate to that directory in your computer.\n\n- Linux: paste the address into your file manager, \\\"Nautilus\\\" or other. You may have to press **Ctrl**+**H** to make the hidden directory `.FreeCAD/` visible.\n- Windows: paste the address into your \\\"File explorer\\\" and confirm.\n- MacOS: locate the folder in the \\\"Finder\\\" or paste the address into a \\\"File explorer\\\"; remember the `file:///` prefix in the \\\"File explorer\\\" for a file on disk.\n\n \n*align=center|Accessing the macros directory in the operating system*\n\n4\\. Add macro files to this directory.\n\n- Linux: leave the file manager open, and bookmark the location for faster access.\n- Windows: leave open the file explorer.\n- MacOS: either leave a \\\"Finder\\\" window open, or bookmark the location in your \\\"File explorer\\\", or set up an \\\"Alias\\\" to point to it, or drag the folder into the \\\"SideBar\\\" of the \\\"Finder\\\" so it is there to use from other programs such as text editors.\n\n \n*align=center|Macros directory*\n\n \n\n\n
\n\n\n
\n\n\n## Installing macros \n\n\n
\n\n\n### Automatic method \n\nStarting with FreeCAD 0.17, use the [Addon Manager](Std_AddonMgr.md) in **Tools → Addon manager** to install a macro that has been included in the [FreeCAD-macros](https://github.com/FreeCAD/FreeCAD-macros) repository.\n\n\n
\n\n\nIn past versions of FreeCAD you could use two automated ways to install macros and other addons:\n\n- [addons_installer.FCMacro](https://github.com/FreeCAD/FreeCAD-addons): itself a macro, this was the precursor to the Addon Manager, and is hosted in the [FreeCAD-addons](https://github.com/FreeCAD/FreeCAD-addons) repository. You don\\'t need to use this tool in new installations of FreeCAD.\n- [freecad-pluginloader](https://github.com/microelly2/freecad-pluginloader): also a macro, it could be used to install new components to FreeCAD. It is no longer developed.\n\nThe recommended way to install addons, that is, [external workbenches](external_workbenches.md) and macros, is the [Addon Manager](Std_AddonMgr.md). However, you can still add macros to your system with the manual methods described in the following sections; this is useful if you are developing and testing your own code.\n\n\n
\n\n\n
\n\n\n
\n\n\n### Manual method 1. Copy the code to the macro editor \n\nFor macros that are relatively small, 300 lines or less, the code can be copied and pasted directly into the FreeCAD macro editor.\n\n\n
\n\n\nWe will use [Macro Apothem Based Prism GUI](Macro_Apothem_Based_Prism_GUI.md) as an example.\n\n1\\. Go to the macro wiki page, which should be listed in [Macros recipes](Macros_recipes.md).\n\nIf there is a custom icon download it; click on it with the right mouse button and select `Save image as...`; place the icon in the macros directory. This icon can be used as a shortcut for the macro in a [custom toolbar](Customize_Toolbars.md). The default icon is .\n\n \n*align=center|Downloading the icon from the macro page*\n\n2\\. In the macro page, select the code inside the **Script** or **Macro** sections, and copy it.\n\n3\\. In FreeCAD, open the menu **Macro → [Macros...](Std_DlgMacroExecute.md)** to open the [Execute macro dialog](Std_DlgMacroExecute.md).\n\n \n*align=center|Opening the Execute macro dialog*\n\n4\\. Click **Create**.\n\n \n*align=center|Creating a new macro*\n\n5\\. Enter the macro name, here `Macro_Apothem_Based_Prism_GUI`, and press **OK**.\n\n \n*align=center|Entering the macro name*\n\n6\\. The macro editor opens, showing the full path of the new macro.\n\n \n*align=center|The macro editor*\n\n7\\. Paste the code in the editor window, and then click the cross on the tab to close the window.\n\n \n*align=center|Closing the macro editor*\n\n8\\. A window appears asking for confirmation to save the code; click on **Yes**. You can also use **Ctrl**+**S** to save the file.\n\nRestart FreeCAD to correctly register the new macro.\n\n \n*align=center|Asking for confirmation to save the code*\n\n9\\. Open the menu again, **Macro → [Macros...](Std_DlgMacroExecute.md)**, select the new macro and press **Execute**.\n\n \n*align=center|Selecting the macro to run it*\n\n10\\. The macro now runs. Fill in the fields with your values and click the **OK** button.\n\n \n*align=center|The macro in action; fill in the information and press OK when ready*\n\n11\\. This macro should return an error if no document is active; other macros open a new document if none exists.\n\nCreate a new document with **File → [New](Std_New.md)**, and then repeat the previous steps to execute the macro.\n\n \n*align=center|The macro returning an error if no document is active*\n\n12\\. Once an active document is available, the macro runs and creates an object.\n\n \n*align=center|Object created by the macro*\n\n13\\. You can open the macro in the editor again to run it or modify it. Go to **Macro → [Macros...](Std_DlgMacroExecute.md)**, select the macro and press **Edit**.\n\n \n*align=center|Opening the macro in the editor*\n\n14\\. The macro can now be run with **Macro → [Execute macro](Std_DlgMacroExecuteDirect.md)**, or by clicking on the ** [Std DlgMacroExecuteDirect](Std_DlgMacroExecuteDirect.md)** button in the toolbar.\n\n \n\n\n
\n\n\n
\n\n\n
\n\n\n### Manual method 2. Add a macro file from a compressed .zip file \n\nSome macros are too big that it\\'s inconvenient to copy and paste them into the macro editor, or they cannot be hosted in the wiki. In this case, the code may be hosted somewhere else, in a Github repository, or in the [FreeCAD forum](https://forum.freecadweb.org/). The code may also be compressed into a `.zip` file, tarball `.tar.xz`, or other type of archive if it contains several files. If the code is distributed in this way, the archive should be extracted and the files placed in the macros directory.\n\n\n
\n\n\nWe will use [Macro screw maker](Macro_screw_maker1_2.md) as an example.\n\n1\\. Download the compressed code from the forum, [Screw Maker](http://forum.freecadweb.org/viewtopic.php?f=22&t=6558#p52887).\n\nYou need to use a decompressor to get the internal files.\n\n- For Windows you can use an application like [7-zip](http://www.7-zip.org/) or [L-Zarc](http://www.kanmandet.dk/?p=37) or [quickzip](http://www.quickzip.org/quickzip51.html).\n- For Linux you can use a command from the terminal\n\n \n```python\nunzip your_file.zip -d your_directory\n```\n\n2\\. Download the compressed archive with the macro code to a local folder.\n\n \n*align=center|Downloading the compressed archive to a local directory*\n\n3\\. Decompress the file in the folder.\n\n \n*align=center|Decompressing the file in the folder*\n\n4\\. The decompressor creates a new directory with the unpacked files.\n\n \n*align=center|New directory created after unpacking the archive*\n\n5\\. Go inside the new directory, and copy or cut the macro file.\n\n \n*align=center|Entering the newly created directory with the decompressed macro file*\n\n6\\. Go to the macro directory and paste the file there.\n\n \n*align=center|Placing the macro file in the macro directory*\n\n7\\. In FreeCAD, open the menu **Macro → [Macros...](Std_DlgMacroExecute.md)** to open the [Execute macro dialog](Std_DlgMacroExecute.md).\n\n \n*align=center|Opening the Execute macro dialog*\n\n8\\. Select the new macro and press **Execute**.\n\n \n*align=center|Selecting the macro to run it*\n\n9\\. The macro now runs. Select the desired options, and click the **Create** button.\n\n \n*align=center|The macro in action; select the desired options, and press Create when ready*\n\n \n*align=center|Object created by the macro*\n\n\n
\n\n\n
\n\n\n## Execute a macro in command line \n\n\n
\n\n\nCommand line execute a macro (.FCMacro or .py)\n\n\n
\n\n### Indentation errors \n\nThe white space at the beginning of the lines (indentation) in the [Python](Python.md) programming language is very important, and an integral part of the code. An inappropriate space may cause the code to not run or present errors.\n\nThis section describes some errors that may be encountered when copying and pasting, and writing macro code.\n\n\n
\n\nA typical indentation error looks like this:\n\n \n```python\n: ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\\n'))\n```\n\n#### Example 1 \n\nIf the code lacks any indentation, the code won\\'t work. Class (`class`) and function definitions (`def()`), as well as control structures (`if`, `while`, `for`) should be followed by a block of indented code.\n\nThis error is possible if the user doesn\\'t copy the code correctly, and all spaces are accidentally removed.\n\n \n*align=center|Python code that lacks any indentation; it will cause an error when it's run*\n\nIndentation problem fixed.\n\n \n*align=center|Python code with the correct indentation*\n\nIf the code is selected, all lines should be highlighted all the way to the left edge, indicating that the lines are aligned.\n\n \n*align=center|Python code highlighted, showing that all lines start at the left edge*\n\n#### Example 2 \n\nIf an additional space is introduced at the beginning of all lines, the Python interpreter will fail and complain about unnecessary indentation. In this case, all lines need the initial space removed.\n\n \n*align=center|Python code with additional space on each line*\n\n#### Example 3 \n\nHere the code has been copied from a forum thread by using the **Select all** button. Apparently the selection is good.\n\n \n*align=center|Python code copied from a forum*\n\nHowever, when the selection is pasted into the macro editor, undesirable indentation seems to appear.\n\n \n*align=center|Python code copied from a forum into the macro editor; unnecessary indentation is added*\n\nIn this case, the initial spaces need to be removed. This can be done with a specialized text editor to quickly decrease the indentation of the lines.\n\nIn Windows, [Notepad++](http://notepad-plus-plus.org/) can perform selection with **Alt** + Mouse dragging, and then use **Edit → Indent → Decrease the indentation**.\n\n \n*align=center|Python code with the correct indentation*\n\n#### Example 4 \n\nHere the selection also selects the line numbers in the code example. If this selection is pasted into the macro editor, it won\\'t work. All line numbers need to be removed, and the spaces adjusted so that the Python code has the proper indentation.\n\n \n*align=center|Selection that also selects the line numbers; if this code is pasted into the macro editor, it won't work*\n\n#### Good code \n\n \n*align=center|Python code with the correct indentation*\n\n\n
\n\n\n
\n\n\n
\n\n\n### No text output from macros \n\nMacros may output information to the report view to detail what the code is doing when it is running.\n\nIf no information is displayed, make sure the report view and [Python](Python.md) console are visible, and that the output is directed tot he report view.\n\n\n
\n\n\n#### Printing information \n\nFreeCAD macros have two methods to print information to the report view.\n\nThe FreeCAD functions \n\n\n```python\nFreeCAD.Console.PrintMessage(\"Hello World! \\n\")\nFreeCAD.Console.PrintError(\"Hello World! \\n\")\nFreeCAD.Console.PrintWarning(\"Hello World! \\n\")\n```\n\n\nThe simple Python function \n\n\n```python\nprint(\"Hello World!\")\n```\n\n\n#### Enabling the report view \n\nTo see the information displayed in the console you should:\n\n1\\. Go to the menu **View → Panels**.\n\n\n\n \n*align=center|Making the panels visible in the menu View → Panels*\n\n2\\. Enable the `Report view` and the `Python console`.\n\n \n*align=center|Enabling the report view and the Python console*\n\n3\\. The panels are now visible, and commands like `FreeCAD.Console.PrintMessage()` now print information that appears in the `Report view`.\n\n \n*align=center|FreeCAD main window with the Report view and the Python console*\n\n#### Enabling the print() command \n\nFreeCAD may need to be configured so the `print()` function of [Python](Python.md) redirects its output correctly to the report view.\n\n1\\. Go into the [Preferences Editor](Preferences_Editor.md) with the menu **Edit → Preferences**.\n\n \n*align=center|Going into the preferences editor*\n\n2\\. Go to **Python** section, and then **Output window → Python interpreter**.\n\n \n*align=center|Output window preferences*\n\n3\\. Check both boxes:\n\n- Redirect internal Python output to report view\n\n- Redirect internal Python errors to report view\n\nand then press the **OK** button.\n\n \n*align=center|Redirecting the Python output to the report view*\n\n \n\n\n
\n\n\n
\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Python Code](Category_Python%20Code.md) > How to install macros\n"}
{"id": "freecad-docs:wiki/Ifcopenshell.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Ifcopenshell.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Ifcopenshell.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "cd8ea4e33164afc04a2bc95d4d375fd4653c3d52c5b8b55f6237665abe1d9c2e", "bytes": 122, "tokens": 53, "text": "# Ifcopenshell\n1. REDIRECT [IfcOpenShell](IfcOpenShell.md)\n\n\n---\n⏵ [documentation index](../README.md) > Ifcopenshell\n"}
{"id": "freecad-docs:wiki/Image_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Image_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Image_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c3ad7981fb456d1fe50d3ec04f40b7f786e92667ded988923da7b9de0aceaf22", "bytes": 2071, "tokens": 665, "text": "# Image Workbench\n**The '''Image Workbench''' is no longer included after version 0.20. \nIts functionality has been integrated in [Std Base](Std_Base.md). See [Std Import](Std_Import.md) and [Std ViewLoadImage](Std_ViewLoadImage.md).**\n\n\n\n \n\n## Introduction\n\nThe [Image Workbench](Image_Workbench.md) manages different types of [bitmap](bitmap.md) images, and allows you to open them in FreeCAD.\n\n## Tools\n\n- [Open\\...](Image_Open.md): open an image on a new viewport.\n- [Create image plane\\...](Image_CreateImagePlane.md): import an image to a plane in the 3D view.\n- [Scale image plane](Image_Scaling.md): scale an image imported to a plane.\n\n## Features\n\n- Like a [Sketch](Sketcher_Workbench.md), an imported image can be attached to one of the main planes XY, XZ, or YZ, and given a positive or negative offset.\n- The image is imported with relation of 1 pixel to 1 millimeter.\n- The recommendation is to have the imported image at a reasonable resolution.\n\n## Workflow\n\nA major use of this workbench is tracing over the image, with the [Draft](Draft_Workbench.md) or [Sketcher](Sketcher_Workbench.md) tools, in order to generate a solid body based on the contours of the image.\n\nTracing over an image works best if the image has a small negative offset, for example, -0.1 mm, from the working plane. This means that the image will be slightly behind the plane where you draw your 2D geometry, so you won\\'t draw on the image itself.\n\nThe offset of the image can be set during import, or changed later through its properties.\n\n\n {{Image Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Obsolete Workbenches](Category_Obsolete%20Workbenches.md) > [Image](Category_Image.md) > Image Workbench\n"}
{"id": "freecad-docs:wiki/Important_information.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Important_information.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Important_information.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9250252273026aa91feda0aa22376ece91d981e2ae6152bb8f5d54c24b15bb32", "bytes": 1150, "tokens": 346, "text": "# Important information\n## Overview\n\n[Important information](Important_information.md) helps troubleshoot problems in your installation and usage of the program.\n\nThe [FreeCAD forum](https://forum.freecadweb.org/viewforum.php?f=3) is the best place to get help from expert users and developers. For other ways see [Help](Help.md).\n\n## Directions\n\n\n**Before asking for help, you need to follow these links or click the images/captions below**\n\n- [IMPORTANT: Please read first before asking for help](https://forum.freecadweb.org/viewtopic.php?f=3&t=2264) in the forum.\n- [Std About](Std_About.md) command in the software itself.\n\n  \n*align=center|The request for important information is located at the top of every subforum. Click the image above to follow link.*\n\n\n\n\n*align=center|Window with the \"[About](Std_About.md)\" information in the software. Do not take a picture of this window; Click the **Copy to clipboard* button to be able to paste the information with your help request.**\n\n\n---\n⏵ [documentation index](../README.md) > Important information\n"}
{"id": "freecad-docs:wiki/Macro_3D_Parametric_Curve.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_3D_Parametric_Curve.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_3D_Parametric_Curve.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "999b4eb7d8c0f51c1b0d7a712bf92ff99a680d43191143d892343bf6381be8ae", "bytes": 7394, "tokens": 2746, "text": "# Macro 3D Parametric Curve\n{{Macro\n|Name=Macro 3D Parametric Curve\n|Icon=Macro_3D_Parametric_Curve.png\n|Description=Draw a function described by parametric equations x(t), y(t) and z(t) with the possibility to choose between B-spline and polyline for the type of line between points.\n|Author=Lucio Gomez (psicofil)\n|Version=2.0\n|Date=2015-03-06\n|FCVersion=All\n|Download=[https://wiki.freecad.org/images/f/f5/Macro_3D_Parametric_Curve.png ToolBar Icon]\n|SeeAlso=[Macro Parametric Curve FP](Macro_Parametric_Curve_FP.md)\n}}\n\n## Description\n\nThis macro creates a curve described by parametric equations x(t), y(t) and z(t), with the possibility to choose between B-spline and polyline for the type of line between points.\n\n \n*Example Epicycloid curve*\n\n## Original Script \n\nYou can find the updated code (13/05/2015) on the following Github repository: [Get the code here!](https://github.com/psicofil/Macros_FreeCAD/blob/master/Macros/ParametricCurve.FCMacro)\n\n## Modified Script \n\n\n\nToolBar Icon \n\n\n**Macro 3D Parametric Curve.FCMacro**\n\n\n{{MacroCode|code=\n\n# -*- coding: utf-8 -*-\n# Create a 3D parametric Curve.\n# Author: Gomez Lucio\n# Modified by Laurent Despeyroux on 9th feb 2015\n# - 3 helping variables added a, b and c\n# - enlarged GUI\n# - more flexible GUI\n# - basic error mangement\n \nimport FreeCAD\nfrom PySide import QtGui,QtCore\nimport Part\nimport Draft\nfrom math import *\n \nclass ParamCurv(QtGui.QWidget):\n def __init__(self):\n super(ParamCurv, self).__init__()\n self.initUI()\n def initUI(self):\n self.t0 = QtGui.QLabel(\"Equation :\",self)\n self.ta = QtGui.QLabel(\" a(t) \",self)\n self.la = QtGui.QLineEdit(self)\n self.la.setText(\"37\")\n self.tb = QtGui.QLabel(\" b(a,t) \",self)\n self.lb = QtGui.QLineEdit(self)\n self.lb.setText(\"1\")\n self.tc = QtGui.QLabel(\" c(a,b,t) \",self)\n self.lc = QtGui.QLineEdit(self)\n self.lc.setText(\"(a+cos(a*t)*2)*b\")\n self.t1 = QtGui.QLabel(\" X(a,b,c,t) \",self)\n self.l1 = QtGui.QLineEdit(self)\n self.l1.setText(\"cos(t)*c\")\n self.t2 = QtGui.QLabel(\" Y(a,b,c,t) \",self)\n self.l2 = QtGui.QLineEdit(self)\n self.l2.setText(\"sin(t)*c\")\n self.t3 = QtGui.QLabel(\" Z(a,b,c,t) \",self)\n self.l3 = QtGui.QLineEdit(self)\n self.l3.setText(\"0\")\n self.t31 = QtGui.QLabel(\"Parameters :\",self)\n self.t4 = QtGui.QLabel(\" Min t \",self)\n self.l4 = QtGui.QLineEdit(self)\n self.l4.setText(\"0\")\n self.t5 = QtGui.QLabel(\" Max t \",self)\n self.l5 = QtGui.QLineEdit(self)\n self.l5.setText(\"6.283185\")\n self.t6 = QtGui.QLabel(\" Interval \",self)\n self.l6 = QtGui.QLineEdit(self)\n self.l6.setText(\"0.01\")\n self.t7 = QtGui.QLabel(\"Type of Line :\",self)\n self.op1 = QtGui.QCheckBox(\" Polyline\",self)\n self.poly = False\n self.op1.stateChanged.connect(self.polyState)\n self.op1.setCheckState(QtCore.Qt.Checked)\n self.op2 = QtGui.QCheckBox(\" Bspline\",self)\n self.bsline = False\n self.op2.stateChanged.connect(self.bsplineState)\n self.t8 = QtGui.QLabel(\" Closed Curve\",self)\n self.op3 = QtGui.QCheckBox(\"\",self)\n self.cclose = False\n self.op3.stateChanged.connect(self.ccloseState)\n self.createbutt = QtGui.QPushButton(\"Create Curve\",self)\n self.exitbutt = QtGui.QPushButton(\"Close\",self)\n layout = QtGui.QGridLayout()\n self.resize(420, 380)\n self.setWindowTitle(\"Parametric Curve \")\n i = 0\n layout.addWidget(self.t0, i, 0)\n i = i+1\n layout.addWidget(self.ta, i, 0)\n layout.addWidget(self.la, i, 1)\n i = i+1\n layout.addWidget(self.tb, i, 0)\n layout.addWidget(self.lb, i, 1)\n i = i+1\n layout.addWidget(self.tc, i, 0)\n layout.addWidget(self.lc, i, 1)\n i = i+1\n layout.addWidget(self.t1, i, 0)\n layout.addWidget(self.l1, i, 1)\n i = i+1\n layout.addWidget(self.t2, i, 0)\n layout.addWidget(self.l2, i, 1)\n i = i+1\n layout.addWidget(self.t3, i, 0)\n layout.addWidget(self.l3, i, 1)\n i = i+1\n layout.addWidget(self.t31, i, 0)\n i = i+1\n layout.addWidget(self.t4, i, 0)\n layout.addWidget(self.l4, i, 1)\n i = i+1\n layout.addWidget(self.t5, i, 0)\n layout.addWidget(self.l5, i, 1)\n i = i+1\n layout.addWidget(self.t6, i, 0)\n layout.addWidget(self.l6, i, 1)\n i = i+1\n layout.addWidget(self.t8, i, 0)\n layout.addWidget(self.op3, i, 1)\n i = i+1\n layout.addWidget(self.t7, i, 0)\n i = i+1\n layout.addWidget(self.op1, i, 0)\n layout.addWidget(self.op2, i, 1)\n i = i+1\n layout.addWidget(self.createbutt, i, 0)\n layout.addWidget(self.exitbutt, i, 1)\n self.setLayout(layout)\n self.show()\n QtCore.QObject.connect(self.createbutt, QtCore.SIGNAL(\"pressed()\"),self.draw)\n QtCore.QObject.connect(self.exitbutt, QtCore.SIGNAL(\"pressed()\"),self.close)\n def ccloseState(self, state):\n if state == QtCore.Qt.Checked:\n self.cclose = True\n else:\n self.cclose = False\n def bsplineState(self, state):\n if state == QtCore.Qt.Checked:\n self.bsline = True\n self.op1.setCheckState(QtCore.Qt.Unchecked)\n else:\n self.bsline = False\n def polyState(self, state):\n if state == QtCore.Qt.Checked:\n self.poly = True\n self.op2.setCheckState(QtCore.Qt.Unchecked)\n else:\n self.poly = False\n def draw(self):\n msgBox = QtGui.QMessageBox()\n fa = str(self.la.text())\n fb = str(self.lb.text())\n fc = str(self.lc.text())\n fx = str(self.l1.text())\n fy = str(self.l2.text())\n fz = str(self.l3.text())\n t = float(str(self.l4.text()))\n tf = float(self.l5.text())\n intv = float(str(self.l6.text()))\n d=(tf-t)/intv\n matriz = []\n for i in range(int(d)):\n try:\n value=\"a\"\n a=eval(fa)\n value=\"b\"\n b=eval(fb)\n value=\"c\"\n c=eval(fc)\n value=\"X\"\n fxx=eval(fx)\n value=\"Y\"\n fyy=eval(fy)\n value=\"Z\"\n fzz=eval(fz)\n except ZeroDivisionError:\n msgBox.setText(\"Error division by zero in calculus of \"+value+\"() for t=\"+str(t)+\" !\")\n msgBox.exec_()\n except:\n msgBox.setText(\"Error in the formula of \"+value+\"() !\")\n msgBox.exec_()\n matriz.append(FreeCAD.Vector(fxx,fyy,fzz))\n t+=intv\n curva = Part.makePolygon(matriz)\n if self.bsline == True:\n Draft.makeBSpline(curva,closed=self.cclose,face=False)\n if self.poly == True:\n Draft.makeWire(curva,closed=self.cclose,face=False)\n def close(self):\n self.hide()\n \nParamCurv()\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Macro 3D Parametric Curve\n"}
{"id": "freecad-docs:wiki/Macro_CirclePlus.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_CirclePlus.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_CirclePlus.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9c25ab982431aa2fced54a38d356ef59133059a148a2ff1e07cacac91b617686", "bytes": 3986, "tokens": 1312, "text": "# Macro CirclePlus\n{{Macro\n|Name=Macro CirclePlus\n|Icon=Macro_CirclePlus.png\n|Description=Creates circle or arc giving radius, diameter, circumference, area, startangle, endangle, arc, anglecenter, cord, arrow, center (point), placemObject on choice (With GUI)\n|Download=[https://www.freecadweb.org/wiki/images/4/4c/Macro_CirclePlus.png ToolBar Icon].\n|Author=mario52\n|FCVersion=All\n|Version=0.4\n|Date=2019/04/07\n}}\n\n## Description\n\nThis macro creates a circle or arc and lets the user, using the following option (via a dialog box), to customize the: *radius, diameter, circumference, area, startangle, endangle, arc, anglecenter, cord, arrow, center (point),* and *placemObject*.\n\nThe circle by default will face the screen (it refers to the function getCameraOrientation to get its orientation). It is possible to change manually change this function to customize the placement of the shape.\n\n### Legend\n\nIn the CirclePlus dialog certain spinboxes will change colors. Green indicates a spinbox that is modified and ready to be run. Orange will indicate the optional spinbox that the user can utilize if deemed necessary. Red indicates a missing or inadequate value. The until the correct values are used.\n\n \n\n## Usage\n\nCopy the code and paste it in the macro directory\n\n\n\n- **X Y Z** : coordinates of circle if not coordinates the circle is created on point 0,0,0\n- **radius** : radius of cicle\n- **diameter** : diameter of circle\n- ****Reset**** : reset the coordinate value\n- ****Equal**** : copy the X value in Y and Z window\n- **CheckBox :**\n- **Options** : other options for create circle\n- **Point** : if checked the central point is created\n- **Info** : if checked display the information give in the macro\n- **Face** : if checked the face is created on circle\n- **Sector** : if checked the sector is created\n- **Segment** : if checked the segment is created\n- **SpinBox 1.0** : step increment for Radius and Diameter (Default: 1.0 (for modify the value on begin change the value Line 87 **\\\"incrementDS = xx.xx\\\"**))\n- **SpinBox 8.0** : give the height of text in the macro\n\n- ****Quit**** : quit the macro (this button is coloured in red in case error)\n- ****Ok**** : create the circle\n\n \n\n- **Options available**\n- **circumference** : circumference of circle\n- **area** : area of circle\n- **startangle** : start angle for arc\n- **endangle** : end angle for arc\n- **arc** and **anglecenter** : arc in combination with anglecenter\n - **arc** = length of arc\n - **anglecenter** = angle of center circle to extremities of arc\n- **cord** and **arrow** : cord in combination with arrow of circle\n - **cord** : length of cord of circle\n - **arrow** : length of arrow of circle\n\n \n\n## Script\n\nDownload image positioning on the icon and then drag the mouse right click \\\"save as\\\" (do not change the name)\n{{CodeDownload|https://gist.github.com/mario52a/0ed8129bacbe9124a41e3ae1d378d5b7|Last version Macro_CirclePlus and the icons at the end of the page}}\n\n## Memo of circle \n\n**Examples codes**\n\n \n\n## Version\n\nver 04 , 07-04-2019 : replace setStyleSheet DoubleSpinBox by setStyleSheet Label cause: the increment in the Dspinbox does not work ??!\n\nver 03 , 06-04-2019 : supp all \\\"(QtGui.QApplication.translate(\\\"MainWindow\\\", \\\"Diameter\\\", None, QtGui.QApplication.UnicodeUTF8))\\\" give error in 0.18.16093 (Git) Hash: 690774c0effe4fd7b8d2b5e2fb2b8c8d145e21ce Python version: 3.6.6 Qt version: 5.6.2\n\nver 0.2 , 05-04-2019 : add increment the step from 1.0 to 0.1 (DoubleSpinbox)\n\nver 0.1 , 2018-07-14 : add create segment\n\nver 0.0 , 2018-07-10 :\n\n\n---\n⏵ [documentation index](../README.md) > Macro CirclePlus\n"}
{"id": "freecad-docs:wiki/Macro_Ellipse-Center+2Points.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Ellipse-Center+2Points.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Ellipse-Center+2Points.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b4bf0dc19aa8462dc42e1fb8df1d16c6c465a1b26dd0c87931606e59ec17d63b", "bytes": 2574, "tokens": 960, "text": "# Macro Ellipse-Center+2Points\n{{Macro\n|Name=Macro Ellipse-Center+2Points\n|Icon=Macro_Ellipse-Center%2B2Points.png\n|Description=Makes an ellipse by selecting three points (in this order): centre, major radius and minor radius\n|Author=Eriossoltero\n|Version=02.00\n|Date=2019-07-29\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/6/66/Macro_Ellipse-Center%2B2Points.png ToolBar Icon]\n}}\n\n## Description\n\nMakes an ellipse by selecting three points (in this order): centre, major radius and minor radius\n\n\n\n## Latest\n\nThe latest version of the macro is to be found at [EllipseCenter2Points.FCMacro](https://github.com/FreeCAD/FreeCAD-macros/blob/master/ObjectCreation/EllipseCenter2Points.FCMacro) but the easiest way to install this macro is through the [Addon Manager](Std_AddonMgr.md).\n\n## Script\n\n\nToolBar Icon \n\n**Macro_EllipseCenter2Points.FCMacro**\n\n\n{{MacroCode|code=\n\n\n# Macro Begin: Ellipse-Center+2Points.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++\n# http://freecad-tutorial.blogspot.com/2011/12/engine-9-poly-v-belt.html\n# https://www.freecadweb.org/wiki/User:Eriossoltero\n# 13/03/2012, 29/07/2019\nimport Part, FreeCAD, math, PartGui, FreeCADGui\nfrom FreeCAD import Base\n\n# get the selected objects, with first selection for the trajectory and second for the section\n# Adapted from:\n# Macro Begin: Ellipse-Center+2Points.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++\n# http://freecad-tutorial.blogspot.com/2011/12/engine-9-poly-v-belt.html\nimport Part, FreeCAD, math, PartGui, FreeCADGui\nfrom FreeCAD import Base\n\n# get the selected objects, with first selection for the trajectory and second for the section\n# Adapted from:\n# http://freecad-tutorial.blogspot.com/2011/12/engine-9-poly-v-belt.html\ns = FreeCADGui.Selection.getSelection()\ntry:\n sel1=s[0].Shape\n sel2=s[1].Shape\n sel3=s[2].Shape\n pt_center = sel1.Point\n pt_radmay = sel2.Point\n pt_radmen = sel3.Point# create Part object in the current document\n myObject=App.ActiveDocument.addObject(\"Part::Feature\",\"Ellipse\")# create a shape and assign it to the current document\n ellipse = Part.Ellipse(pt_radmay, pt_radmen, pt_center)\n myObject.Shape = ellipse.toShape()\n # Macro End: Ellipse-Center+2Points.FCMacro +++++++++++++++++++++++++++++++++++++++++++++++++\n\nexcept:\n print( \"Wrong selection\")\n print( \"First:centre, Second:major radius and Third:minor radius\")\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Macro Ellipse-Center+2Points\n"}
{"id": "freecad-docs:wiki/Macro_FCInfoToMouse.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_FCInfoToMouse.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_FCInfoToMouse.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "24b8316f8a60a38c0c2b276363c23cd4b40de2e0af07312d4242e0844ea66506", "bytes": 19984, "tokens": 5981, "text": "# Macro FCInfoToMouse\n{{Macro\n|Name=Macro FCInfoToMouse\n|Icon=FCInfoToMouse.png\n|Description=Provides info about coordinates, length, and angles in real-time next to the mouse pointer.\n|Author=Mario52\n|Download=[https://wiki.freecad.org/images/1/10/FCInfoToMouse.png ToolBar Icon]\n|Version=00.04\n|Date=2018-03-27\n}}\n\n## Description\n\nProvides info about coordinates, length, and angles in real-time next to the mouse pointer in a bubble annotation displayed in the [3D view](3D_view.md)\n\n \n\n \n*FCInfoToMouse macro in action*\n\n## Usage\n\n1. Install the FCInfoToMouse macro in your macros directory via the [Addon Manager](Std_AddonMgr.md)\n2. Run the [Macro](Macros.md)\n\n: Result: an annotation appears and the mouse coordinate information is displayed in real-time.\n\n\n: \n\n : \n\n : \n \n*Figure 1*\n \n\n - **X, Y, Z**: mouse coordinates are displayed in the bubble (this only applies when \\\"Single\\\" mode is enabled) as seen in Fig. 1\n\n: \n\n : Once the mouse is clicked for the first time, additional info is displayed (when \\\"Forced\\\" mode is enabled this setting will be solely displayed)\n\n\n: \n\n : \n\n : \n \n*Figure 2*\n \n\n - **X1, Y1, Z1** : Initial coordinates of the 1st mouse click\n\n - **X2, Y2, Z2** : Current coordinates of the mouse\n\n - **L** : Length between the first mouse click and the location of the current mouse pointer\n\n - **XY, YZ, XZ** : Angles between the 1st point and moving mouse pointer in the XY, YZ, and XZ planes \n\n: \n\n : \n\n: \n \n*Figure 3 - when mouse pointer is over an object, the name of the object will be displayed*\n \n\n\n: \n\n : If the mouse hovers over an object, the object name appears at the top of the annotation (see Figure 3).\n\n \n\n### Keyboard Shortcuts \n\n****SHIFT** + **Q****: Quit the FCInfoToMouse macro. Upon quitting the macro, the annotation remains at its current mouse pointer location. Begin using the mouse normally if you want to delete the annotation manually.\n\n****SHIFT** + **M****: Toggle the mode between:\n\n- **single** which displays only the coordinates of the mouse pointer (Figure 1)\n- **force** which displays the \\\"**comprehensive visualisation**\\\" (Figure 2)\n- **normal** which displays the default behavior of the macro\n\n****SHIFT** + **C**** : for \\\"**hidden / visible**\\\"\n\n****SHIFT** + **D**** : to \\\"**Open/Close**\\\" a Spreadsheet with the coordinates saved to:\n\n: {\\| class=\\\"wikitable\\\" style=\\\"text-align: center; color: green;\\\"\n\n!Cell **A** !Cell **B** !Cell **C** !Cell **D** \\|- \\|x, y, z\n\n\n\n\n\\|x\n\n\n\n\n\\|y\n\n\n\n\n\\|z\n\n\n\n\n\\|}\n\n### Notes\n\nAt any time, you can change the properties of the annotation by clicking the object FCInfoToMouse in Combo View and click the View tab\n\nIf you want change the number of decimal change the line 43 (default 4)\n\nExample for 6 decimal places:\n\noriginal value \n```python\nglobal arrondi ; arrondi = 4\n``` replace to \n```python\nglobal arrondi ; arrondi = 6\n```\n\nTo make the configuration of the permanent annotation you can change the values in the configuration section lines **104 to 122**\n\n \n\n## Script\n\nThe icon **FCInfoToMouse.png** for the [Customize_ToolsBar](http://www.freecadweb.org/wiki/index.php?title=Customize_ToolsBar) \n\n**Macro_FCInfoToMouse.FCMacro**\n\n\n{{MacroCode|code=\n\n# -*- coding: utf-8 -*-\n\"\"\"\n***************************************************************************\n* Copyright (c) 2016 *\n* *\n* This file is a supplement to the FreeCAD CAx development system. *\n* *\n* This program is free software; you can redistribute it and/or modify *\n* it under the terms of the GNU Lesser General Public License (LGPL) *\n* as published by the Free Software Foundation; either version 2 of *\n* the License, or (at your option) any later version. *\n* for detail see the LICENCE text file. *\n* *\n* This software is distributed in the hope that it will be useful, *\n* but WITHOUT ANY WARRANTY; without even the implied warranty of *\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *\n* GNU Library General Public License for more details. *\n* *\n* You should have received a copy of the GNU Library General Public *\n* License along with this macro; if not, write to the Free Software *\n* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *\n* USA *\n***************************************************************************\n* WARNING! All changes in this file will be lost and * \n* may cause malfunction of the program *\n***************************************************************************\n\"\"\"\n# http://forum.freecadweb.org/viewtopic.php?f=22&t=9215\n# FCInfoToMouse\n\n__title__ = \"FCInfoToMouse\"\n__author__ = \"Mario52\"\n__url__ = \"https://www.freecadweb.org/wiki/Macro_FCInfoToMouse\"\n__version__ = \"00.04\"\n__date__ = \"27/03/2018\"\n#\nimport Draft, Part\nimport math,FreeCAD\nfrom FreeCAD import Base\nimport time\nApp = FreeCAD\n\nglobal arrondi ; arrondi = 4\n\nglobal objectAnn ; objectAnn = \"\" \nglobal positionX1 ; positionX1 = 0.0\nglobal positionY1 ; positionY1 = 0.0\nglobal positionZ1 ; positionZ1 = 0.0\nglobal force ; force = 0\nglobal hidden ; hidden = 0\nglobal coorBegin ; coorBegin = \"\"\nglobal pas ; pas = 0\n\nglobal spreadSheet; spreadSheet= 0\nglobal compteur ; compteur = 0 \nglobal spread ; spread = \"\"\n\nfrom math import sqrt, pi, sin, cos, asin, acos, atan, atan2, degrees\n\ndef angle2(vecteur_x1,vecteur_y1,vecteur_x2,vecteur_y2,mode): #tester getAngle ( Vector )\n# calcul de l'inclinaison d'une ligne a partir de deux Vecteurs\n# si \"mode\" = 1 alors affichage en degres sinon en radian\n try:\n deltaX = vecteur_x2 - vecteur_x1\n deltaY = vecteur_y2 - vecteur_y1\n if mode ==1:\n angle = degrees(atan2(float(deltaY),float(deltaX))) # degres (mode = 1)\n else:\n angle = atan2(float(deltaY),float(deltaX)) # radian (mode = 0)\n return round(angle,arrondi)\n except Exception:\n None\n\ndef sub(first, other): \n \"sub(Vector,Vector) - subtracts second vector from first one\"\n if isinstance(first,FreeCAD.Vector) and isinstance(other,FreeCAD.Vector):\n return FreeCAD.Vector(first.x-other.x, first.y-other.y, first.z-other.z)\n\ndef length(first):\n \"lengh(Vector) - gives vector length\"\n if isinstance(first,FreeCAD.Vector):\n return math.sqrt(first.x*first.x + first.y*first.y + first.z*first.z)\n\ndef dist(first, other):\n \"dist(Vector,Vector) - returns the distance between both points/vectors\"\n if isinstance(first,FreeCAD.Vector) and isinstance(other,FreeCAD.Vector):\n return length(sub(first,other))\n\ndef codeColor(color):\n try:\n rgb = float((float(color)/255.0))\n except Exception:\n rgb = 0.0\n return rgb\n\n\ndoc = FreeCAD.ActiveDocument \nif doc == None:\n doc = FreeCAD.newDocument()\n\n# for modify the configuration : line 104 to 122\n# PS: if DisplayMode = \"Line\" and Frame = False the annotation is transparent\n#\n##### Configuration Modify here # Begin #######################################\n #\n#BackgroundColor : #\nred_B = 0.0 # 0.0 to 255.0 #\ngreen_B = 84.0 # 0.0 to 255.0 #\nblue_B = 255.0 # 0.0 to 255.0 #\n #\ndisplayMode = \"Line\" # \"Line\" or \"Object\" #\nfontName = \"MS Shell Dlg 2\" # \"MS Shell Dlg 2\" for Windows #\nfontSize = 8.0 # Font size #\nframe = False # \"False\" or \"True\" #\njustification = \"Left\" # \"Left\", \"Right\", \"Center\" #\n #\n#TextColor : #\nred_T = 255.0 # 0.0 to 255.0 #\ngreen_T = 255.0 # 0.0 to 255.0 #\nblue_T = 255.0 # 0.0 to 255.0 #\n #\n##### Configuration End End ###################################################\n\nv=Gui.activeDocument().activeView()\nobjectAnn = App.ActiveDocument.addObject(\"App::AnnotationLabel\",\"FCInfoToMouse\")# create work annotation\nobjectAnn.LabelText=[\"Hello FreeCAD World\"]\n\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).BackgroundColor = (codeColor(red_B),codeColor(green_B),codeColor(blue_B)) #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).DisplayMode = displayMode #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).FontName = fontName #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).FontSize = fontSize #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).Frame = frame #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).Justification = justification #\nFreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).TextColor = (codeColor(red_T),codeColor(green_T),codeColor(blue_T)) #\n\nimport os, sys, platform\nglobal PolicePath; PolicePath = \"\"\n\n#if platform.system() == \"Windows\" :\n# PolicePath = \"C:/Windows/Fonts/ARIAL.TTF\"\n#elif platform.system() == \"Linux\" :\n# PolicePath = \"/usr/share/fonts/truetype/ubuntu-font-family/Ubuntu-M.ttf\"\n#elif platform.system() == \"Darwin\":\n# PolicePath = \"/Library/Fonts/Arial.ttf\"\n#else:\n# PolicePath = \"C:/Windows/Fonts/ARIAL.TTF\"\n\np=FreeCAD.ParamGet(\"User parameter:BaseApp/Preferences/Mod/Draft\")\nPolicePath = p.GetString(\"FontFile\")\n\nclass ViewObserver:\n def __init__(self, view):\n self.view = view\n\n def logPosition(self, info):\n global objectAnn\n global positionX1, positionY1, positionZ1\n global pas, arrondi\n global coorBegin\n global force\n global hidden\n global PolicePath\n global spreadSheet\n global compteur\n global spread\n\n######## for testing key ############\n# try: #\n# print info[\"Key\"] #\n# print info[\"State\"] #\n## print ord(info[\"Key\"]) #\n# except Exception: #\n# None #\n#####################################\n\n Button1 = 0\n\n try:\n if (info[\"Key\"] == \"Q\") and (info[\"State\"] == \"DOWN\"): # SHIFT + Q for quit\n v.removeEventCallback(\"SoEvent\",c) # close event observation\n FreeCAD.Console.PrintMessage( \"End FCInfoToMouse\" + \"\\n\")\n except Exception:\n None\n\n try:\n if (info[\"Key\"] == \"M\") and (info[\"State\"] == \"DOWN\"): # SHIFT + M for force display\n if force == 0:\n force = 1\n FreeCAD.Console.PrintMessage( \"Forced \" + \"\\n\")\n elif force == 1:\n force = 2\n FreeCAD.Console.PrintMessage( \"Single \" + \"\\n\")\n elif force == 2:\n force = 0\n FreeCAD.Console.PrintMessage( \"Normal \" + \"\\n\")\n except Exception:\n None\n\n try:\n if (info[\"Key\"] == \"C\") and (info[\"State\"] == \"DOWN\"): # SHIFT + C for hidden / visible annotation OK\n if hidden == 0:\n hidden = 1\n FreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).Visibility = False\n FreeCAD.Console.PrintMessage( \"concealed \" + \"\\n\")\n else:\n hidden = 0\n FreeCADGui.getDocument(doc.Name).getObject(objectAnn.Label).Visibility = True\n FreeCAD.Console.PrintMessage( \"visible \" + \"\\n\")\n except Exception:\n None\n\n try:\n if (info[\"Key\"] == \"D\") and (info[\"State\"] == \"DOWN\"): # SHIFT + S for Open spreadSheet\n if spreadSheet == 0:\n #spread = FreeCAD.ActiveDocument.getObjectsByLabel(spread.Name)[0] # for append in existant SpreadSheet\n spread = App.activeDocument().addObject('Spreadsheet::Sheet','MySpreedSheett')\n spreadSheet = 1\n FreeCAD.Console.PrintMessage(\"SpreadSheet open : \" + spread.Name + \"\\n\")\n else:\n spreadSheet = 0\n FreeCAD.Console.PrintMessage(\"SpreadSheet closed\" + \"\\n\")\n compteur = 0\n except Exception:\n None\n\n try:\n object2 = \"\"\n object = v.getObjectInfo(v.getCursorPos()) # here for object preselected\n object2 = object[\"Object\"] + \".\" + object[\"Component\"] # object + component\n pnt = FreeCAD.Vector(float(object[\"x\"]),float(object[\"y\"]),float(object[\"z\"]))# vector on position mouse to object\n# print \"pnt \",pnt\n except Exception:\n pos = info[\"Position\"] # if mouse in 3D view\n pnt = self.view.getPoint(pos) # vector detect on mouse position 3D view\n# print \"pnt \",pnt\n\n try:\n if (info[\"Button\"] == \"BUTTON1\") and (info[\"State\"] == \"DOWN\"): # coordinates clic to mouse\n positionX1 = round(pnt[0],arrondi)\n positionY1 = round(pnt[1],arrondi)\n positionZ1 = round(pnt[2],arrondi)\n \n coorBegin = \"\"\n coorBegin = \"X1: \"+str(positionX1)+\" Y1: \"+str(positionY1)+\" Z1: \"+str(positionZ1)\n if pas == 0:\n pas = 1\n else:\n pas = 0\n\n try: # spreadSheet\n if spreadSheet == 1:\n compteur += 1\n spread.set(\"A\"+str(compteur) , str(positionX1) + \", \" + str(positionY1) + \", \" + str(positionZ1))\n spread.set(\"B\"+str(compteur) , str(positionX1))\n spread.set(\"C\"+str(compteur) , str(positionY1))\n spread.set(\"D\"+str(compteur) , str(positionZ1))\n App.ActiveDocument.recompute()\n FreeCAD.Console.PrintMessage(str(compteur) + \" : \" + str(positionX1) + \", \" + str(positionY1) + \", \" + str(positionZ1) + \"\\n\")\n except Exception:\n None\n \n except Exception:\n None\n\n try:\n objectAnn.BasePosition = (pnt[0], pnt[1], pnt[2])\n if force == 2:\n objectAnn.LabelText = [\"X: \" + str(round(pnt[0],arrondi)) + \" Y: \" + str(round(pnt[1],arrondi)) + \" Z: \" + str(round(pnt[2],arrondi))]\n else:\n if ((pas == 1) or (force == 1)):\n coorEnd = longueur = angles = \"\"\n coorEnd = \"X2: \" + str(round(pnt[0],arrondi)) + \" Y2: \" + str(round(pnt[1],arrondi)) + \" Z2: \" + str(round(pnt[2],arrondi))\n longueur = \"L: \" + str(round(dist(FreeCAD.Vector(positionX1,positionY1,positionZ1), FreeCAD.Vector(pnt[0], pnt[1], pnt[2])),12)) # around to 12 decimales\n alphaXY = alphaXY = alphaXZ = 0.0\n alphaXY = str(round(angle2(positionX1,positionY1,pnt[0],pnt[1],1),arrondi))\n alphaYZ = str(round(angle2(positionY1,positionZ1,pnt[1],pnt[2],1),arrondi))\n alphaXZ = str(round(angle2(positionX1,positionZ1,pnt[0],pnt[2],1),arrondi))\n \n angles = \"XY: \" + alphaXY + unichr(176) + \" YZ: \" + alphaYZ + unichr(176) + \" XZ: \" + alphaXZ + unichr(176) # unichr(176) = degrees character\n \n if object2 == \"\":\n objectAnn.LabelText = [coorBegin, coorEnd, longueur, angles,]\n else:\n objectAnn.LabelText = [object2, coorBegin, coorEnd, longueur, angles,]\n else:\n if object2 == \"\":\n objectAnn.LabelText = [\"X: \" + str(round(pnt[0],arrondi)) + \" Y: \" + str(round(pnt[1],arrondi)) + \" Z: \" + str(round(pnt[2],arrondi)),]\n else:\n objectAnn.LabelText = [object2, \"X: \" + str(round(pnt[0],arrondi)) + \" Y: \" + str(round(pnt[1],arrondi)) + \" Z: \" + str(round(pnt[2],arrondi))]\n\n except Exception:\n FreeCAD.Console.PrintError(\"End FCInfoToMouse by an error\" + \"\\n\")\n v.removeEventCallback(\"SoEvent\",c) # close event observation\n\n##### Begin ######\nFreeCAD.Console.PrintMessage(\"__Welcome to FCInfoToMouse__\" + \"\\n\")\nFreeCAD.Console.PrintMessage(\"SHIFT + Q : for quit\" + \"\\n\")\nFreeCAD.Console.PrintMessage(\"SHIFT + M : for force display, mode single, mode normal\" + \"\\n\")\nFreeCAD.Console.PrintMessage(\"SHIFT + C : for concealed / visible\" + \"\\n\")\nFreeCAD.Console.PrintMessage(\"SHIFT + D : for create spreadSheet / close spreadSheet\" + \"\\n\")\nFreeCAD.Console.PrintMessage(\"____________________________\" + \"\\n\")\n\npas = 0\no = ViewObserver(v)\ntry:\n c = v.addEventCallback(\"SoEvent\",o.logPosition)\nexcept Exception:\n App.ActiveDocument.removeObject(objectAnn.Label)\n FreeCAD.Console.PrintMessage( \"Not GUI End FCInfoToMouse\" + \"\\n\")\n\n\n}}\n\n\nor to Gists [Macro_FCInfoToMouse.FCMacro](https://gist.github.com/mario52a/974214c4b83beaa41495) or the zip [Macro_FCInfoToMouse.FCMacro.zip](https://gist.github.com/mario52a/974214c4b83beaa41495/archive/d62630049d4663369fc80519a7655ee4c32c8711.zip) \n\n## Limitation\n\nIt is possible that the macro does not recognize some keys \n\n## Links\n\nThe discussion on the forum [From autocad to freecad](http://forum.freecadweb.org/viewtopic.php?f=3&t=13592)\n\nMy macros on [mario52a](https://gist.github.com/mario52a) gists \n\n## Version\n\n27/03/2018 ver 00.04 : add function \\\"Save the coordinate in a spreadSheet key \\\"D\\\" flip/flop on,off\n\n24/01/2016 ver 00.03 : add section configuration and replace key \\\"C\\\" to \\\"M\\\"\n\n23/01/2016 ver 00.02 : add function \\\"single\\\", replace key \\\"H\\\" to \\\"C\\\" and correct bug\n\n02/01/2016 : ver 0.1\n\n\n---\n⏵ [documentation index](../README.md) > Macro FCInfoToMouse\n"}
{"id": "freecad-docs:wiki/Macro_Geodesic_Dome.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Geodesic_Dome.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Geodesic_Dome.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "569ca4f8e6e67b667ec755585ed1ea438d7577074fbabec27fdd45b9fc851b71", "bytes": 14835, "tokens": 4925, "text": "# Macro Geodesic Dome\n{{Macro\n|Name=Macro Geodesic Dome\n|Icon=Macro_Geodesic_Dome.svg\n|Description=This macro creates a parametric geodesic dome shell. The dome radius and the frequency parameter will be set at creation time.\n|Author=Ulrich Brammer, DeepSOIC, galou\n|Version=02.00\n|Date=2019-03-24\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/File:Macro_Geodesic_Dome.svg ToolBar Icon]\n}}\n\n## Description\n\nThis macro creates a parametric geodesic dome shell. The dome radius and the frequency parameter will be set at creation time.\n\n {{Codeextralink|https://raw.githubusercontent.com/FreeCAD/FreeCAD-macros/master/ParametricObjectCreation/geodesic_dome/geodesic_dome.py}}\n\n \n\n## Usage\n\n1\\. Install the macro using Addon Manager (menu Tools → Addon Manager). On tab \\\"Macros\\\", pick \\\"GeodesicDome\\\", click \\\"Install\\\". Then close addon manager.\n\n2\\. Run GeodesicDome.FCMacro. A dialog should appear\n\n3\\. Specify the parameters, click OK.\n\na dome shape should appear. You can then edit dome parameters by altering properties of GeoDome object.\n\n## Script\n\n(this is an old, non-parametric version of the script. Up-to-date version is in FreeCAD-macros repository, [here!](https://github.com/FreeCAD/FreeCAD-macros/blob/master/ParametricObjectCreation/geodesic_dome/geodesic_dome.py) ) \n\nToolBar Icon \n\n**Macro_Geodesic_Dome.FCMacro**\n\n # -*- coding: utf-8 -*-\n\n # Form implementation generated from reading ui file 'geodesic_dialog.ui'\n # And changed manually to use FreeCAD \"Gui::InputField\"\n # Created: Sun Jan 4 22:20:58 2015\n # by: pyside-uic 0.2.15 running on PySide 1.2.2\n #\n # Upgrade 2019/06/16 for use with FreeCAD 0.19 version\n #OS: Windows 10 (10.0)\n #Word size of OS: 64-bit\n #Word size of FreeCAD: 64-bit\n #Version: 0.19.16993 (Git)\n #Build type: Release\n #Branch: master\n #Hash: 5ea062f6699666b2f284f6a52105acf20828b481\n #Python version: 3.6.8\n #Qt version: 5.12.1\n #Coin version: 4.0.0a\n #OCC version: 7.3.0\n\n '''\n ************************************************************************\n * Copyright (c)2015 2019 Ulrich Brammer *\n * *\n * This file is a supplement to the FreeCAD CAx development system. *\n * *\n * This program is free software; you can redistribute it and/or modify *\n * it under the terms of the GNU Lesser General Public License (LGPL) *\n * as published by the Free Software Foundation; either version 2 of *\n * the License, or (at your option) any later version. *\n * for detail see the LICENCE text file. *\n * *\n * This software is distributed in the hope that it will be useful, *\n * but WITHOUT ANY WARRANTY; without even the implied warranty of *\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *\n * GNU Library General Public License for more details. *\n * *\n * You should have received a copy of the GNU Library General Public *\n * License along with this macro; if not, write to the Free Software *\n * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *\n * USA *\n * *\n ************************************************************************\n '''\n\n\n from PySide import QtCore, QtGui\n import FreeCAD, FreeCADGui, math, Part\n from FreeCAD import Base\n\n class Ui_Dialog(object):\n def setupUi(self, Dialog):\n Dialog.setObjectName(\"Dialog\")\n Dialog.resize(477, 188)\n self.dia = Dialog\n self.gridLayoutWidget = QtGui.QWidget(Dialog)\n self.gridLayoutWidget.setGeometry(QtCore.QRect(19, 19, 440, 141))\n self.gridLayoutWidget.setObjectName(\"gridLayoutWidget\")\n self.gridLayout = QtGui.QGridLayout(self.gridLayoutWidget)\n self.gridLayout.setContentsMargins(0, 0, 0, 0)\n self.gridLayout.setObjectName(\"gridLayout\")\n self.label = QtGui.QLabel(self.gridLayoutWidget)\n self.label.setObjectName(\"label\")\n self.gridLayout.addWidget(self.label, 0, 0, 1, 1)\n #self.lineEdit = QtGui.QLineEdit(self.gridLayoutWidget)\n fui = FreeCADGui.UiLoader()\n self.lineEdit = fui.createWidget(\"Gui::InputField\")\n \n self.lineEdit.setObjectName(\"lineEdit\")\n self.gridLayout.addWidget(self.lineEdit, 0, 1, 1, 1)\n self.label_2 = QtGui.QLabel(self.gridLayoutWidget)\n self.label_2.setObjectName(\"label_2\")\n self.gridLayout.addWidget(self.label_2, 1, 0, 1, 1)\n self.lineEdit_2 = QtGui.QLineEdit(self.gridLayoutWidget)\n self.lineEdit_2.setObjectName(\"lineEdit_2\")\n self.gridLayout.addWidget(self.lineEdit_2, 1, 1, 1, 1)\n self.label_3 = QtGui.QLabel(self.gridLayoutWidget)\n self.label_3.setObjectName(\"label_3\")\n self.gridLayout.addWidget(self.label_3, 2, 0, 1, 1)\n self.buttonBox = QtGui.QDialogButtonBox(self.gridLayoutWidget)\n self.buttonBox.setOrientation(QtCore.Qt.Horizontal)\n self.buttonBox.setStandardButtons \\\n (QtGui.QDialogButtonBox.Cancel|QtGui.QDialogButtonBox.Ok)\n self.buttonBox.setObjectName(\"buttonBox\")\n self.gridLayout.addWidget(self.buttonBox, 2, 1, 1, 1)\n\n self.retranslateUi(Dialog)\n QtCore.QObject.connect(self.buttonBox, \\\n QtCore.SIGNAL(\"accepted()\"), self.makeSomething)\n QtCore.QObject.connect(self.buttonBox, \\\n QtCore.SIGNAL(\"rejected()\"), self.makeNothing)\n QtCore.QMetaObject.connectSlotsByName(Dialog)\n\n def retranslateUi(self, Dialog):\n # original code commented 2019/06/16\n # Dialog.setWindowTitle(QtGui.QApplication.translate \\\n # (\"Dialog\", \"Geodesic Dome Creator\", \\\n # None, QtGui.QApplication.UnicodeUTF8))\n # self.label.setText(QtGui.QApplication.translate \\\n # (\"Dialog\", \"Dome Radius\", None, QtGui.QApplication.UnicodeUTF8))\n # self.label_2.setText(QtGui.QApplication.translate \\\n # (\"Dialog\", \"Frequency Parameter\\n(Integer between 1 to 10)\", \\\n # None,QtGui.QApplication.UnicodeUTF8))\n # self.label_3.setText(QtGui.QApplication.translate \\\n # (\"Dialog\", \"This Macro creates \\na full geodesic dome shell.\\nX-Y-symmetry plane \\nfor even frequencies\", \\\n # None, QtGui.QApplication.UnicodeUTF8))\n ####\n # replacement code 2019/06/16\n Dialog.setWindowTitle(\"Geodesic Dome Creator\")\n self.label.setText(\"Dome Radius\")\n self.label_2.setText(\"Frequency Parameter\\n(Integer between 1 to 10)\")\n self.label_3.setText(\"This Macro creates \\na full geodesic dome shell.\\nX-Y-symmetry plane \\nfor even frequencies\")\n ####\n\n def makeSomething(self):\n print( \"accepted! Dome radius: \", self.lineEdit.property(\"text\"), \\\n \" with Frequency: \", int(self.lineEdit_2.text()))\n\n doc=App.activeDocument()\n label = \"GeodesicDome\"\n\n theDome = doc.addObject(\"Part::Feature\",label)\n radius = self.lineEdit.property(\"text\")\n frequency = int(self.lineEdit_2.text())\n \n self.dia.close()\n self.makeDome(theDome, radius, frequency)\n doc.recompute()\n \n \n def makeNothing(self):\n print( \"rejected!!\")\n self.dia.close()\n \n\n\n def makeDome(self, obj, domeRad_str, ny):\n \n def makeFreqFaces(fPt, sPt, thPt, ny = 1):\n # makes the geodesic dome faces out of the points of an\n # icosahedron triangle\n b = self.a/ny # length of frequent triangles\n # definition of direction vectors\n growVec = (sPt - fPt)\n # growVec = (fPt - sPt)\n growVec.multiply(1.0/ny)\n crossVec = (thPt - sPt)\n # crossVec = (sPt - thPt)\n crossVec.multiply(1.0/ny)\n \n for k in range(ny):\n kThirdPt = fPt + growVec * (k+0.0)\n dThirdPt = Base.Vector(kThirdPt.x, kThirdPt.y, kThirdPt.z)\n dThirdPt = dThirdPt.normalize().multiply(domeRad.Value)\n kSecPt = fPt + growVec * (k+1.0)\n dSecPt = Base.Vector(kSecPt.x, kSecPt.y, kSecPt.z)\n dSecPt = dSecPt.normalize().multiply(domeRad.Value)\n # thirdEdge = Part.makeLine(kSecPt, kThirdPt)\n # thirdEdge = Part.makeLine(dSecPt, dThirdPt)\n for l in range(k+1):\n firstPt = kSecPt + crossVec *(l+1.0)\n dFirstPt = firstPt.normalize().multiply(domeRad.Value)\n secPt = kSecPt + crossVec *(l+0.0)\n dSecPt =secPt.normalize().multiply(domeRad.Value)\n thirdPt = kThirdPt + crossVec *(l+0.0)\n dThirdPt = thirdPt.normalize().multiply(domeRad.Value)\n #thirdEdge = Part.makeLine(secPt, thirdPt)\n thirdEdge = Part.makeLine(dSecPt, dThirdPt)\n # Part.show(thirdEdge)\n if l > 0:\n print( \"in l: \", l, \" mod 2: \", l%2)\n # What to do here?\n #secEdge = Part.makeLine(oThirdPt,thirdPt)\n secEdge = Part.makeLine(doThirdPt,dThirdPt)\n # Part.show(secEdge)\n #thirdEdge = Part.makeLine(secPt, thirdPt)\n #thirdEdge = Part.makeLine(dSecPt, dThirdPt)\n # Part.show(thirdEdge)\n triWire = Part.Wire([firstEdge, secEdge, thirdEdge])\n # Part.show(triWire)\n triFace = Part.Face(triWire)\n self.domeFaces.append(triFace)\n #Part.show(triFace)\n \n oThirdPt = thirdPt\n doThirdPt = oThirdPt.normalize().multiply(domeRad.Value)\n # oFirstPt = firstPt\n #firstEdge = Part.makeLine(thirdPt,firstPt)\n firstEdge = Part.makeLine(dThirdPt,dFirstPt)\n oFirstEdge = firstEdge\n #secEdge = Part.makeLine(firstPt,secPt)\n secEdge = Part.makeLine(dFirstPt,dSecPt)\n #Part.show(firstEdge)\n #Part.show(secEdge)\n #Part.show(thirdEdge)\n triWire = Part.Wire([firstEdge, secEdge, thirdEdge])\n triFace = Part.Face(triWire)\n self.domeFaces.append(triFace)\n #Part.show(triFace)\n \n \n domeRad = FreeCAD.Units.Quantity(domeRad_str)\n \n # self.a = Strutlength of underlying icosahedron:\n self.a=(4.0*domeRad.Value)/math.sqrt(2.0*math.sqrt(5.0)+10.0) \n \n # icoAngle: angle of vertices of icosahedron points \n # not a north or south pole\n self.icoAngle = math.atan(0.5)\n \n self.icoLat = domeRad.Value * math.sin(self.icoAngle)\n self.latRad = domeRad.Value * math.cos(self.icoAngle)\n self.ang36 = math.radians(36.0)\n \n # Calculation all points of the icosahedron\n self.icoPts = []\n self.icoPts.append(Base.Vector(0.0, 0.0, domeRad.Value))\n \n for i in range(10):\n self.icoCos = self.latRad * math.cos(i*self.ang36)\n self.icoSin = self.latRad * math.sin(i*self.ang36)\n if i%2 == 0:\n self.icoPts.append(Base.Vector(self.icoSin, self.icoCos, self.icoLat))\n else:\n self.icoPts.append(Base.Vector(self.icoSin, self.icoCos, -self.icoLat))\n \n self.icoPts.append(Base.Vector(0.0, 0.0, -domeRad.Value))\n \n # making the faces of the icosahedron\n \n self.icoFaces = [] # collects faces of the underlying icosahedron\n self.domeFaces = [] # collects the faces of the geodesic dome\n \n thirdPt = self.icoPts[9]\n thirdEdge = Part.makeLine(self.icoPts[0],thirdPt)\n for i in range(5):\n j = i*2+1\n firstEdge = Part.makeLine(thirdPt,self.icoPts[j])\n secEdge = Part.makeLine(self.icoPts[j],self.icoPts[0])\n triWire = Part.Wire([firstEdge, secEdge, thirdEdge])\n triFace = Part.Face(triWire)\n self.icoFaces.append(triFace)\n # Part.show(triFace)\n makeFreqFaces(self.icoPts[j], self.icoPts[0], thirdPt, ny)\n \n thirdEdge = Part.makeLine(self.icoPts[0],self.icoPts[j])\n thirdPt = self.icoPts[j]\n \n thirdPt = self.icoPts[9]\n secPt = self.icoPts[10]\n thirdEdge = Part.makeLine(secPt,thirdPt)\n \n for i in range(10):\n j = i+1\n firstEdge = Part.makeLine(thirdPt,self.icoPts[j])\n secEdge = Part.makeLine(self.icoPts[j],secPt)\n triWire = Part.Wire([firstEdge, secEdge, thirdEdge])\n triFace = Part.Face(triWire)\n self.icoFaces.append(triFace)\n #Part.show(triFace)\n makeFreqFaces(self.icoPts[j], secPt, thirdPt, ny)\n \n thirdPt = secPt \n secPt = self.icoPts[j] \n thirdEdge = Part.makeLine(secPt,thirdPt)\n \n \n thirdPt = self.icoPts[10]\n thirdEdge = Part.makeLine(self.icoPts[11],thirdPt)\n for i in range(5):\n j = i*2+2\n firstEdge = Part.makeLine(thirdPt,self.icoPts[j])\n secEdge = Part.makeLine(self.icoPts[j],self.icoPts[11])\n triWire = Part.Wire([firstEdge, secEdge, thirdEdge])\n triFace = Part.Face(triWire)\n self.icoFaces.append(triFace)\n #Part.show(triFace)\n makeFreqFaces(self.icoPts[j], self.icoPts[11], thirdPt, ny)\n \n thirdEdge = Part.makeLine(self.icoPts[11],self.icoPts[j])\n thirdPt = self.icoPts[j]\n \n # Shell of a corresponding icosahedron \n newShell = Part.Shell(self.icoFaces)\n #Part.show(newShell)\n \n # Shell of the geodesic dome\n #self.domeShell = Part.Shell(self.domeFaces)\n #Part.show(self.domeShell)\n obj.Shape = Part.Shell(self.domeFaces)\n \n # Shere with radius of geodesic dome for debugging purposes\n testSphere = Part.makeSphere(domeRad.Value)\n #Part.show(testSphere)\n \n\n d = QtGui.QWidget()\n d.ui = Ui_Dialog()\n d.ui.setupUi(d)\n d.ui.lineEdit_2.setText(\"2\")\n d.ui.lineEdit.setProperty(\"text\", \"2 m\")\n\n d.show()\n\n\n## Link\n\nForum [Designing geodesic dome](https://forum.freecadweb.org/viewtopic.php?t=9174)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Geodesic Dome\n"}
{"id": "freecad-docs:wiki/Macro_Half-Hull_Model.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Half-Hull_Model.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Half-Hull_Model.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6ad03e255ae4d69b0c02c0df04d4f164c61b922d590de13c304d0ecf6b7cee31", "bytes": 26388, "tokens": 8116, "text": "# Macro Half-Hull Model\n{{Macro\n|Name=Macro Half-Hull Model\n|Icon=Macro_Half_Hull_Model.png\n|Description=This macro generates both three dimensional half-hull and full-hull models from a series of 2D line drawings. This macro makes simple models of the hulls of boats and ships. It is intended to aid people modeling or designing hulls by providing the hull surface in a straight forward and timely fashion so they can avoid the time consuming full process.\n|Author=Piffpoof\n|Version=1.0\n|Date=2016-01-25\n|FCVersion=<= 0.16\n|Download=[https://www.freecadweb.org/wiki/images/4/44/Macro_Half_Hull_Model.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro makes simple models of the hulls of boats and ships. It is intended to aid people modeling or designing hulls by providing the hull surface in a straight forward and timely fashion so they can avoid the time consuming full process.\n\n \n\n\n\n## Background\n\nSince antiquity boat builders have had to design boats and then realise them in a three dimensional environment where very few lines are straight, very few surfaces flat and no angles constant over a distance. Hull models were used to make to-scale models which could then be used to review the design or communicate concepts to other persons. The laws of hydrodynamics demand that any vessel passing through a liquid be symmetrical in the cross-section if it is to track (move in a straight line) accurately. Consequently building one side of the hull in the model was all that was necessary - if the half-hull was perfect then its mirror image would also be perfect. In latter years half-hulls became used for symbolic purposes such as plaques, and nautical art.\n\nThis code came out of a project to build a model in FreeCAD of a 12.5 metre sailing boat. The builders no longer had drawings and the son of the original owner doubted there ever were full drawings. Consequently the hull dimensions had to be measured and then a model constructed within the software, Modern software packages like FreeCAD offer many beneficial features like symmetry constraints but when the final measurement is a model that is \\\"easy on the eye\\\", much \\\"massaging\\\" of models is required. This code was written to help automate that process.\n\nThe initial purpose of this code was to provide a symmetrical hull which was malleable so it could be fitted to the 3D model being constructed. As the software progressed it was generalised so hopefully it would be of some use to persons:\n\n- boat designers producing boat diagrams which can be built from\n- boat builders who are trying to model what is described on their diagrams\n- model hull builders.\n\nCertainly commercial boat designers have all sorts of high end software to assist their work, this isn\\'t supposed to replace that. Rather this is for the hobbyist or home builder to tinker around with.\n\nNautical blueprints have a distinct history with respect to buildings and so are somewhat different in presentation. This is an example of a sailing boat which is more than a century old:\n\n\n\nOne of the end goals of this software is to use the Draft workbench to generate some of these diagrams using the model to generate the lines.\n\n**Note on Units in FreeCAD:**\n\nAt present there isn\\'t really any units management system within FreeCAD, but obviously a boat builder or modeller will need an accurate dimensioning system. To use this macro, decide to set the FreeCAD grid size to what ever is appropriate for your work (e.g. mm, cm, inch, foot). FreeCAD is consistent, one FreeCAD unit will constantly equal to one FreeCAD unit. And if you have decided to have a FreeCAD unit equal a specific physical length, then your drawings will remain consistently dimensioned. At present there is work on a units system for FreeCAD so this situation may change soon.\n\n## Description \n\nFor this macro the hull shapes are defined by a minimum of 3 FreeCAD Sketches: one in the YZ plane, one or more in the XZ plane, one in the XY plane. Here is the minimum hull supported by this macro, it has only 3 Sketches:\n\n\n\nNote: in the above diagram we are looking directly at the stern, the bow is pointing away from the viewpoint.\n\nFrom front to back (bow to stern) the 3 Sketches are:\n\n\n
\n\n\n
\n\n\n
\n\nstemline\n\n\n
\n\n\n
\n\nYZ plane\n\n\n
\n\n\n
\n\nred line in sketch\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\ncross-section\n\n\n
\n\n\n
\n\nXZ plane\n\n\n
\n\n\n
\n\ngreen line in Sketch\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\ntransom\n\n\n
\n\n\n
\n\nXY plane\n\n\n
\n\n\n
\n\nblue line in Sketch\n\n\n
\n\n\n
\n\n\n
\n\nPerhaps it is easier to see with 7 Sketches (one in YZ plane, one in XY plane and 5 in the XZ plane):\n\n\n\nWith 5 Sketches in the XZ plane it is becoming easier to perceive the shape of the hull. The next 2 pictures show the Sketch lines superimposed on the model FreeCAD constructs,\n\n\n\nthe second is the same model rotated 90 degrees so the bow is in the foreground:\n\n\n\nSome points to consider:\n\n- the Sketches are only for:\n - the stemline (or bow line) in the YZ plane (red in the above diagram);\n - the top of the transom in the XY plane (blue in the above diagram);\n - multiple cross-sections of the hull in the XZ plane (green in the above diagram)\n- only the starboard side of the hull is drawn in the Sketches, the port side will be generated as a mirror image\n- each multiple-segment line must be in a separate Sketch\n- each Sketch must have the same number of line segments (which is 3 in the previous examples)\n- the more line segments in each Sketch, the closer the FreeCAD generated model will approximate a curved hull\n- there is no limit to the number of line segment in each Sketch, any number from one up\n- there is no limit to the number of Sketches in the XZ plane (i.e. cross-sections), any number from one up\n\nWith enough Sketches the model generated may even approach:\n\n\n\nThe HalfHull macro generates 4 models:\n\n- starboard half-hull\n- port half-hull\n- complete hull\n- bulkheads for the complete hull, either with a flush deck or with a coachhouse\n\nThese models are all output in the unified location space of FreeCAD so they can be fitted together - for example the bulkheads can be inserted into the complete hull seamlessly. This is a picture of bulkheads in a boat model during construction:\n\n\n\nAs well as the bulkheads generated by the macro (note that these bulkheads are for a coachhouse rather than a flush deck):\n\n\n\nThe composite image below shows the main outputs from this software (the port side half-hull is actually not shown but it is the mirror of the starboard half-hull which is shown). The outputs are in clockwise order from the upper left corner:\n\n- starboard half-hull\n- complete hull\n- bulkheads (for flush deck, the bulkheads in the previous image were for a coachhouse deck)\n- the complete hull with the bulkheads inserted\n\n\n\nAs novelty features, the macro will also optionally produce plaques for the half-hulls, and even a bottle for the complete hull:\n\n\n\n\n\n## Installation\n\nAll the code for halfHullModel.FCMacro is in one macro. So installation is comprised of copying the code to the appropriate Macro directory and invoking the Build Utility from the Macro menu, the Python console or a toolbar button (the preferred method).\n\n- see [How to install macros](How_to_install_macros.md) for information on how to install this macro code\n- see [Customize Toolbars](Customize_Toolbars.md) for information how to install as a button on a toolbar\n\n## Usage\n\nThe FreeCAD operations involved in generating the hull model are rather complex and numerous. Things like the direction a line is drawn can cause the FreeCAD construction of the hull to either abort or turn out like:\n\n\n\nConsequently the steps below need to be followed closely. The macro does allow for certain data inconsistencies but generally if the data (i.e. the Sketches) are incorrect then the output will look like a cheese grater or the macro fill fail with an error.\n\nThe following instructions refer to the quadrants of the XY graph, this refers to the 4 quarters of the XY graph and they are labelled as follows:\n\n\n\n**Create a New Document**\n\nThe very first thing is to create a new document in FreeCAD . This document will hold all the Sketches that make up your hull definition.\n\n### Create the Stemline \n\nThe first step is one of creating data for the hull model to be made from. The data is supplied in the form of Sketches within FreeCAD. After the hull model is generated, if changes are to be made then the Sketches are simply edited, and the second step of running the macro repeatedly.\n\n1. create a new sketch , in the YZ-Plane\n2. start at origin (0,0) and draw upwards into Quadrant I\n \n3. the bottom end of the stemline is at the origin (0,0) - this will be the point from where the placement of all the cross-sections and transom will be made\n4. the number of line segments in this Sketch determines the number which will be required in each other Sketch\n5. save sketch \n6. for ease of identification it is probably worth naming the Sketch something like \\\"stemline sketch\\\"\n\n### Create the Cross-section Sketch(es) \n\n1. create a new sketch , in the XZ-Plane\n2. the following dialog will appear:\n \n The dialog is asking how far from the origin the Sketch should be placed. This will refer to how far the cross-section is from the bottom of the stemline (which was placed at (0,0)). The cross-sections can be equally spaced but need not be. The forward-most cross-section will be at Y=0 (i.e. the origin where the stemline bottom ends) or at Y\\<=0. The cross-sections will be at increasingly negative Y values until the transom is at the most negative Y value. In the example above, the cross-section Sketch will be placed 50 FreeCAD units from the origin on the negative Y axis.\n3. start on the Y axis and draw upwards into Quadrant I\n - the first (i.e. foremost) cross-section should start at origin (0,0) (or it will look odd as the stemline ends at 0,0) but other cross-sections need only start on the Y axis.\n \n4. use the same number of line segments as in the Stemline Sketch\n5. save sketch \n6. repeat as this step necessary, it may be quicker to copy this sketch and then space the copies on the Y-axis, modifications may be made to the individual Sketches as required\n7. for naming, it will make things easier to give some sort of sequence to the cross-sections, starting at the bow (i.e. the stemline) and increasing towards the stern (i.e. the transom)\n\n### Create the Transom Sketch in the XY Plane \n\n1. create a new sketch , in the XY-Plane\n2. start on the Y axis between quadrant III and IV, and draw upwards into Quadrant IV so that the end point is coincident with the rightmost point of the lowest cross-section Sketch in the YZ-plane\n \n3. use the same number of line segments as in the stemline Sketch\n4. save sketch \n5. for ease of identification it is probably worth naming the Sketch something like \\\"transom sketch\\\"\n\n**Save the New Document**\n\nNow save the document which contains the Sketches that will define the hull shape, giving it some name that is descriptive\n\nOnce the Sketches have all been created and positioned, the document should look like this from the top view :\n\n\n\nThe principal limitations for constructing the model are:\n\n- the stemline bottom should end at (0,0)\n- the bottom centremost end of each cross-section should end at the Y axis - note that it can have any Z value\n\nThis concludes the first step which is one of creating the data which the macro will use to create both half-hulls and complete-hulls. The second step is described in the following section which is titled User Interface\n\n## User Interface \n\nIn this step the macro will gather some information from the user and then process the input Sketches to generate the desired hull models. This is the only GUI image for the macro and is primarily configuration details for the production of the hull models from the Sketches:\n\n\n\nThe choices on the GUI window are:\n\n- Starboard half-hull\n - checking this will cause the macro to produce a starboard half-hull model\n - Mounting plaque\n - if checked the macro will mount the half-hull on a plaque\n - Allow space for keel\n - if checked will cause the half hull to be mounted higher on the plaque than the centre position, this is so a separately generated keel could be placed below the hull\n- Port half-hull\n - checking this will cause the macro to produce a port half-hull model\n - Mounting plaque\n - if checked the macro will mount the half-hull on a plaque\n - Allow space for keel\n - if checked will cause the half hull to be mounted higher on the plaque than the centre position, this is so a separately generated keel could be placed below the hull\n- Complete hull\n - checking this will cause the macro to produce a complete model\n - Bottle for complete hull\n - if checked the macro will place the complete hull inside a transparent bottle (complete with cork)\n - Allow space for keel\n - if checked will cause the half hull to be positioned higher in the bottle than the centre position, this is so a separately generated keel could be placed below the hull\n- Bulkheads for flush deck\n - checking this will cause the macro to produce bulkheads whose tops are level with the top of the hull, bulkheads will not be generated for the most forward 2 cross-sections or the aft-most 2 cross-sections\n- Bulkheads for coachhouse\n - checking this will cause the macro to produce bulkheads whose tops are possibly above the top of the hull.\n - Bulkheads to skip at bow determines how many cross-sections will be left without a bulkhead at the bow\n - Bulkheads to skip at stern determines how many cross-sections will be left without a bulkhead at the stern\n- The dimensions of the top of the bulkheads will be configured as per the following diagram:\n \n- Cancel button\n - the execution is halted and the window closes\n- Re-Use Last File button\n - the execution uses the data file AND SETTINGS from the the last run, any changes to settings are ignored\n- Select File button\n - the standard Open File window is opened where the user can either select a file or Cancel and exit\n\nWhen the macro runs it takes configuring data from the user and then reads Sketcher sketches in the selected input file.\n\nNote: As the macro works through the Sketches it prints out any exceptions as well as some milestones on the Report View. If you get unexpected results or some parts are missing, that is probably the first place to check.\n\n## Options\n\nThere are various types of bows and sterns for boats, with sterns having much more variety than bows. Here are examples of transoms and bows from the real world alongside the similar macro output:\n\n**Sheer Stern**\n\nProbably the most common stern, typical of all sizes of vessels from commercial ships through to rowing boats.\n\n\n
\n\n- the XY transom should be as close to the aftmost cross-section as is possible.\n\n**Sugar-Scoop Stern**\n\nMost likely to be found on a sailing yacht, it is a product of designing to maximise the length of the waterline to benefit from class rules for racing under sail.\n\n\n
\n\n- place the aftmost 2 cross-sections as close as is feasible, then rotate the aftmost of the two through to an angle of 45 degrees (or whatever is called for) around the X-axis\n\n**Canoe Stern**\n\nFound on all sizes of water craft, power and sail, pleasure and commercial.\n\n\n
\n\n- place the aftmost 2 cross-sections as close as is feasible, then rotate the aftmost of the two through to an angle of 45 degrees around the X-axis\n\n**Normal Bow**\n\nThere is a lot less variety in bow shapes than with transoms:\n\n\n
\n\n**Trireme Bow**\n\nAlthough not seen very frequently in the last 2 millenia, this was once the definitive bow profile for war-making vessels:\n\n\n
\n\n- in order for the bow to be correct the poly-line for the stemline needs to be drawn from the bottom to the top which will mean right to left in the Sketcher\n\n## Sample Files \n\nThese files are samples of Sketch data to use with the macro, mainly they are the models for the screen snapshots in the Options section above. The files work with the Macro and so can be downloaded and played with to adapt to your specific requirements. The prefix of 5x3 (for example) means the model has 5 cross-sections and 3 line segments per cross-section (i.e. sketch)\n\nTo use one of the example files, right-click on the file link and select Save File As\\... from the menu. The filename will be specified, choose the desired folder/directory to hold the example file.\n\n- \\[\\| 3x1 hull\\] with the minimum number of Sketches (stemline, one cross-section, transom) with 1 line segment per Sketch \\<\\<\\<\\<\\< NOT CURRENTLY WORKING\n- \\[\\| 5x3 with normal bow\\]\n- \\[\\| 5x3 with trireme bow\\]\n- \\[\\| 5x3 with canoe stern\\]\n- \\[\\| 5x3 with sheer transom stern\\]\n- \\[\\| 5x3 with sugar scoop stern\\]\n- \\[\\| 5x5 workboat\\]\n- \\[\\| 7x5 pirate boat\\]\n- \\[\\| 12x3 sailing yacht\\]\n\n## Remarks\n\n- almost all the examples on this page are generated with only 3 line segments defining the side of the hull which gives a very faceted appearance, increasing the number of segments in each Sketch would generate a much smoother surface which would increase the realism\n- doesn\\'t do keels, skegs or rudders, in other words, it doesn\\'t do any of the wet area\n- doesn\\'t do square bows like push-boats or towed barges\n- doesn\\'t do submarines (although it will do the lower half of a submarine)\n\n## Known Problems \n\nThe \\'Ruled Surface\\' feature of FreeCAD is used to generate the hull sections from the Sketches. It can sometimes generate the wrong result and display a grater like surface instead of a smooth planar one. This will typically occur when the Sketches are rotated such as when a Sugar Scoop stern is modeled. Also angling a Sheer Transom stern can cause this. If it occurs then typically it will do so in either the half-hull models or the complete hull model - it never seems to occur in all three models for the same hull. Also it usually only happens at the extreme bow or stern. If it happens to section in the middle of the boat then most likely one of the Sketches was drawn in the wrong direction (i.e. either random sequence or top-down where as all lines should be drawn bottom-up)\n\nIt can usually be removed by using the following steps:\n\n- in the Model tab of the Combo View, click on the faulty segment to select it, the faulty segment will show as highlighted on the display\n- select the Data tab on the bottom half of the Combo View, the lower part of the window will have a Label \\\"Ruled Surface\\\" with a single parameter \\'Orientation\\'\n- there is a popup menu to the right which has the values \\'Automatic\\', \\'Forward\\', \\'Reversed\\', it will initially be set to \\'Automatic\\'\n- try one of the other settings (remembering the faulty segment must still be selected in the upper part of the Combo View) which will usually correct the problem\n\nThe following screen snapshot shows the relevant portion of the screen:\n\n\n\n## Future Possibilities \n\n- replace line segments of cross-sections with curved lines\n - this is just at the idea stage but would give a much smoother surface in the vertical dimension, however the horizontal surface would still be faceted as it is now\n- integrate with Draft workbench to produce drawings from models\n - an initial goal, but the feasibility has not been investigated\n- handle keels, skegs and rudders\n - one work around for keels with the present system is to model the keel as a half-hull on it\\'s own and then assemble it onto the bottom of the main hull; this would still do nothing for rudders and skegs though\n\n## Glossary\n\nAs with any ancient and practiced trade, a rich and sometimes confusing vocabulary has developed around ships, boats and nautical practices. In describing this macro it is both awkward and inefficient to describe the process without using the correct and accurate terms. The obvious problem is that the average lay person will be unfamiliar with such terminology, hence this vocabulary:\n\n\n
\n\n\n
\n\n\n
\n\naft\n\n\n
\n\n\n
\n\nthe rear aspect of anything on a boat\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nchine\n\n\n
\n\n\n
\n\na planar facet of a hull, can be used to\n\n approximate a curved surface or as a finished building technique\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\ncoachhouse\n\n\n
\n\n\n
\n\nthe part of the central deck which is raised above the deck level - usually to accommodate increased headroom in the interior of the boat\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nflush deck\n\n\n
\n\n\n
\n\na deck that runs smoothly from the top of one side of the hull to the other, the converse to a coachhouse deck\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nforward\n\n\n
\n\n\n
\n\nalso \\'fore\\'; the front aspect of anything on a boat\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nport\n\n\n
\n\n\n
\n\nlefthand side looking forward\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nstarboard\n\n\n
\n\n\n
\n\nrighthand side looking forward\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\nstemline\n\n\n
\n\n\n
\n\nthe sloped vertical edge which is the bow of a hull\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\n\n
\n\ntransom\n\n\n
\n\n\n
\n\nthe curved top edge of the stern face which can be flat or curved\n\n\n
\n\n\n
\n\n\n
\n\n## Links\n\n- [Half Hull Model Ship](http://en.wikipedia.org/wiki/Half_hull_model_ship) (Wikipedia)\n- [Why Half Hulls](http://www.halfhullshipmodels.com/smf/discussions-of-half-hulls-and-ship-models/understanding-and-practising-half-hull-boat-modelling/?PHPSESSID=56fedd9f6fa2db453a77347f10d57b7f) (Maritime Half Hull Ship Models and Nautical Art website)\n- [Traditional Model Yacht Design](http://pages.swcp.com/usvmyg/design/design.htm) (US Vintage Model Yacht Group)\n\n## Script\n\n ToolBar Icon \n\n**Macro_Half_Hull_Model.FCMacro** \n\nThis script is running bug free. But due to the large range of possible inputs it may fail for some inputs. If so please report it.\n\nThe script is too long for the Wiki to display so it must be copied or downloaded from [unabbreviated script on pastebin.com](http://pastebin.com/raw.php?i=tZMpUi6F)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Half-Hull Model\n"}
{"id": "freecad-docs:wiki/Macro_Megaminx.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Megaminx.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Megaminx.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "75d913653406fb7282b51494b8bc82c87549c3e0027dd2a9dbd4475c24fb7e73", "bytes": 2492, "tokens": 742, "text": "# Macro Megaminx\n{{Macro\n|Name=Macro_Megaminx\n|Icon=Macro_Megaminx.png\n|Description=This macro creates a virtual [https://en.wikipedia.org/wiki/Megaminx Megaminx].\n|Author=aleph0\n|SeeAlso=[Macro Rubik Cube](Macro_Rubik_Cube.md)\n|Date=2019-02-17\n|FCVersion=0.18 and higher\n|Download=[https://www.freecadweb.org/wiki/images/4/43/Macro_Megaminx.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro creates a FreeCAD document containing a virtual a virtual [Megaminx](https://en.wikipedia.org/wiki/Megaminx) and enables you to manipulate it. It displays six views of the Megaminx including each of the twelve faces at least once. There are various arrows (each with a tooltip which will be displayed as long as you hover the mouse over it). By clicking on arrows you can rotate faces of the Megaminx, rotate the whole Megaminx, or rotate or reflect the history which it maintains of the rotations that you have done so far. There is also a Megaminx menu which is shown at the right of the menu bar as long as you have at least one Megaminx document open. From the menu you can display some help text, reset the Megaminx to its initial (solved) state, undo the last rotation (and remove it from the history), copy the history to the clipboard, step through the history, randomise the Megaminx, and enable or disable the echoing of rotations to the Report View. All of these functions can also be invoked by typing suitable commands into the Python console window.\n\nA history saved to the clipboard can be pasted into the Python console window or copied into a file which can be called as a macro into the active Megaminx document. You can have more than one Megaminx document open at a time, although only one can be active.\n\n## Script\n\nToolBar icon \n\n {{Codeextralink|https://raw.githubusercontent.com/rparkins999/Megaminx/master/Megaminx.FCMacro}}\n\n**Macro_Megaminx.FCMacro**\n\n\n\n\n## Use\n\nDownload the code from into your macro directory. Run the macro to create a Megaminx document. Then you can play with it. The history functions can be used to construct and save operators (aka algorithms) which do useful transformations on the Megaminx. A suitable set of these will give you a complete solution. The step_history function can be used to help you play back an operator onto a real Megaminx.\n\n\n---\n⏵ [documentation index](../README.md) > Macro Megaminx\n"}
{"id": "freecad-docs:wiki/Macro_Recompute_Profiler.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Recompute_Profiler.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Recompute_Profiler.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0f38d6b80bcf048b48ffb23f16f417a80c279619c797bb62c6c3cf803029b545", "bytes": 7682, "tokens": 2574, "text": "# Macro Recompute Profiler\n{{Macro\n|Name=Macro Recompute Profiler\n|icone=Macro_Recompute_Profiler.png\n|Description=This macro is to help you find, what features cause long delays in updates to the project. It performs a recompute, measuring the time it takes to recompute each feature.\n|Author=DeepSOIC\n|Version=0.1\n|Date=2017-04-03\n|FCVersion=0.17.10644 and above\n|Download=[https://www.freecadweb.org/wiki/images/c/ca/Macro_Recompute_Profiler.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro is to help you find, what features cause long delays in updates to the project. It performs a recompute, measuring the time it takes to recompute each feature.\n\n## Usage\n\nThis macro requires FreeCAD no less than 0.17.10644\n\nSave the macro to a file.\n\n1\\. Open your project\n\n2\\. Right-click an object in model tree, pick \\\"Mark to recompute\\\"\n\n3\\. Run this macro.\n\nA progress bar will appear. As each object is recomputed, a line is printed to Report View, containing the time and the label of the object. If any object fails to recompute, the macro will display an error message and terminate the process.\n\n## Macro\n\nToolBar Icon \n\n**RecomputeProfiler.FCMacro**\n\n\n{{MacroCode|code=\n__Title__=\"Macro Recompute Profiler\"\n__Author__ = \"DeepSOIC\"\n__Version__ = \"0.1\"\n__Date__ = \"03.04.2017\"\n\n__Comment__ = \"Measures time it takes to recmpute features in a project\"\n__Wiki__ = \"https://www.freecadweb.org/wiki/index.php?title=Macro_Recompute_Profiler\"\n__Help__ = \"Right-click an object, and pick 'Mark to recompute', then run this macro. This will only profile recomputing the subgraph. To profile the whole project, right-click the project in tree view, and pick 'Mark to recompute', then run this macro. Results will be printed to report view.\"\n__Status__ = \"experimental\"\n__Requires__ = \"freecad 0.17.10644\"\n__Communication__ = \"https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=3888\" \n\nimport FreeCAD as App\n\nimport FreeCADGui as Gui\n\nclass ExecutionError(Exception):\n pass\n\nclass CancelError(Exception):\n pass\n\ndef execute(feature):\n feature.recompute()\n if 'Invalid' in feature.State:\n raise ExecutionError(\"Feature '{label}' failed to recompute\".format(label= feature.Label))\n\ndef msgbox(title, text):\n from PySide import QtGui\n mb = QtGui.QMessageBox()\n mb.setIcon(mb.Icon.Information)\n mb.setText(text)\n mb.setWindowTitle(title)\n mb.exec_()\n\ndef log(string):\n App.Console.PrintWarning(string+\"\\n\")\n\ndef getAllDependent(feat_list):\n '''getAllDependent(feat_list): gets all features that depend on features in feat_list, directly or indirectly.\n Returns a set. Features from feat_list are not included, unless there are interdependencies between them.'''\n\n list_traversing_now = feat_list\n set_of_deps = set()\n list_of_deps = []\n\n while len(list_traversing_now) > 0:\n list_to_be_traversed_next = []\n for feat in list_traversing_now:\n for dep in feat.InList:\n if not (dep in set_of_deps):\n set_of_deps.add(dep)\n list_of_deps.append(dep)\n list_to_be_traversed_next.append(dep)\n\n list_traversing_now = list_to_be_traversed_next\n\n return set_of_deps\n\n\ndef run():\n touched = [obj for obj in App.ActiveDocument.Objects if 'Touched' in obj.State]\n\n if len(touched) == 0:\n App.ActiveDocument.RecomputesFrozen = True\n msgbox(\"Macro Recompute Profiler\", \"Project was switched to suspend recomputes. Please modify an object that triggers a recompute, and run this macro again. The macro will perform a step-by-step recompute, and measure the time it takes to recompute features.\")\n return\n\n log(\"{n} features are touched\".format(n= len(touched)))\n\n log(\"Generating execution order...\")\n\n to_be_executed = set.union(getAllDependent(touched), set(touched))\n log(\"Number of features to execute: {n}\".format(n= len(to_be_executed)))\n\n exec_list = []\n for obj in App.ActiveDocument.TopologicalSortedObjects[::-1]:\n if obj in to_be_executed:\n exec_list.append(obj)\n assert(len(exec_list) == len(to_be_executed))\n n = len(exec_list)\n\n log(\"Execution order:\")\n for obj in exec_list:\n log(\" \"+obj.Label)\n\n\n import PySide\n progress = PySide.QtGui.QProgressDialog(u\"Preparing to recompute....\", u\"Abort\", 0, n+1)\n progress.setModal(True)\n progress.show()try:\n log(\"Recomputing... (time in seconds, label)\")\n import time\n for obj in exec_list:\n progress.setValue(progress.value()+1)\n progress.setLabelText(\"Recomputing {feature}...\".format(feature= obj.Label))\n if progress.wasCanceled():\n raise CancelError()\n\n time_start = time.time()\n try:\n execute(obj)\n finally:\n exec_time = time.time()-time_start\n log(\"\\t{time}\\t{label}\".format(time= exec_time, label= obj.Label))\n\n progress.setValue(n+1)\n msgbox(\"Macro Recompute Profiler\", \"Recompute completed. Results are in report view.\")\n\n for obj in exec_list:\n obj.purgeTouched()\n\n except Exception as err:\n msgbox(\"Macro Recompute Profiler\", \"An error occured: {err}\".format(err= str(err)))\n finally:\n progress.hide()\n App.ActiveDocument.RecomputesFrozen = False\n\nrun()\n}}\n\n\n## Post-processing results \n\nThe output of the macro will be interleaved with general messages produced by recomputing features. It generally looks like this:\n\n {{code|code=\nRecomputing... (time in seconds, label)\nSketcher::setUpSketch()-T:0\nSketcher::Solve()-DogLeg-T:0\n 0.00999999046326 Sketch - master section\n 0.0199999809265 Clone of Sketch - master section (2D)001\nSketcher::setUpSketch()-T:0\nSketcher::Solve()-DogLeg-T:0\n 0.00999999046326 Sketch013\nSketcher::setUpSketch()-T:0\nSketcher::Solve()-DogLeg-T:0\n 0.00999999046326 Sketch011\n 0.0 Clone of Sketch - master section (2D)\nSketcher::setUpSketch()-T:0\nSketcher::Solve()-DogLeg-T:0\n 0.0 Sketch008\n 0.130000114441 LinearArray\nSketcher::setUpSketch()-T:0\nSketcher::Solve()-DogLeg-T:0\n...\n}}\n\nThe result lines have an easy signature to separate them off: they start with a tab. So, if you copy-paste the whole chunk to a spreadsheet program, generic messages will end up in column 1, while the results are in columns 2 and 3. So, you can sort by column 2, to get a nice table like that:\n\n {{code|code=\n0.59100008 Slice\n0.352999926 Populate LinearArray with Compound\n0.160000086 CompoundFilter\n0.138999939 Cut\n0.130000114 LinearArray\n0.108999968 Fusion\n0.069999933 Moved CompoundFilter\n0.067000151 Module - spokes\n0.029999971 Sweep\n0.019999981 Clone of Sketch - master section (2D)001\n0.010999918 ArrayFilter003\n...\n}}\n\n(For MS-Excel, pasting right after copying text from report view doesn\\'t split it into columns, don\\'t know why\\... pasting the text to Notepad and re-copying it from Notepad and pasting to excel helps.)\n\n## FreeCAD version \n\nThis macro requires FreeCAD no less than 0.17.10644, which was the version where App.ActiveDocument.RecomputesFrozen became available. It might be functional with a bit older FreeCAD, but certainly won\\'t work with v0.16.\n\nThis macro was created using this version of FreeCAD:\n\n \n```python\nOS: Windows 10\nWord size of OS: 64-bit\nWord size of FreeCAD: 64-bit\nVersion: 0.17.10665 (Git)\nBuild type: Release\nBranch: master\nHash: 47847513a85ff6615774ef628230f79e37471daf\nPython version: 2.7.8\nQt version: 4.8.7\nCoin version: 4.0.0a\nOCC version: 7.0.0\n```\n\n\n---\n⏵ [documentation index](../README.md) > Macro Recompute Profiler\n"}
{"id": "freecad-docs:wiki/Macro_Remove_parametric_history.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Remove_parametric_history.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Remove_parametric_history.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d1fd5cf8180e4d26c2505bf266b76c54d30935b6431cfe723afa3e4d7b146421", "bytes": 1079, "tokens": 385, "text": "# Macro Remove parametric history\n{{Macro\n|Name=Remove parametric history\n|Icon=Macro_Remove_parametric_history.png\n|Description=This will remove all parametric associativity from an object, leaving it as a \"dumb\" shape\n|Author=Yorik\n|Version=1.0\n|Date=2011-08-01\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/b/b7/Macro_Remove_parametric_history.png ToolBar Icon]\n}}\n\n## Description\n\nThis will remove all parametric associativity from an object, leaving it as a \\\"dumb\\\" shape\n\nBefore and after:\n\n\n\n\n\n## Script\n\n\nToolBar Icon \n\n**Remove parametric history.FCMacro**\n\n\n{{MacroCode|code=\n\noriginalObject = FreeCAD.ActiveDocument.ActiveObject\nnewShape = originalObject.Shape.copy()\nnewName = FreeCAD.ActiveDocument.ActiveObject.Name\nFreeCAD.ActiveDocument.removeObject(newName)\nnewObject = FreeCAD.ActiveDocument.addObject(\"Part::Feature\",newName)\nnewObject.Shape = newShape\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Macro Remove parametric history\n"}
{"id": "freecad-docs:wiki/Macro_Template.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Template.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Template.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9b2a0841c592953939bcf14fdc82aad187a168749b79d0410a08c570a879ed9f", "bytes": 3756, "tokens": 1095, "text": "# Macro Template\n{{Macro\n |Name=Macro_Template\n |Description=Minimum required text to publish the FreeCAD Addon.\n |Author=Screeneroner\n |Version=Template\n |Date=2023-09-28\n}}\n\n## THE GUIDE \n\nTo make your macro available in the Addon Manager, it must be published in the FreeCAD Repository. There are two ways to do it with and without GitHub. Publishing via GitHub requires its deep knowledge, which most of us haven\\'t. So here will be described the easiest way - without GitHub.\n\nActually the FreeCAD Repository is a wiki web page . Once you (by yourself) add here a link to the properly formatted wiki-page, you macros will be shown in the FreeCAD Addon Manager. To make changes to this repository page and pages with your macros, you should become a wiki-editor. You can\\'t register as the editor by yourself. Instead, you should send a private message to \\@yorik and/or \\@Kunda1 with request containing you login and preferred e-mail (the latest changes in getting wiki editing permissions you may find here ). Once you get a e-mail with admins response (be patient - it may request several days), follow the link in it activate your new account, then set a permanent password, and confirm your e-mail. Now you can start publishing your macros.\n\nThe following codes snippets you should use to create your own macro that will be available in the FreeCAD Addon Manager:\n\n1. for wiki page about your macro with its code inside\n2. for making your macro visible in the FreeCAD Addon Manager macros list.\n\n## 1. Code for pasting into your wiki page editor \n\nType in your web browser address (replace the placeholder \\'My_Macro_Name\\' with your real name). The prefix \\\"Macro\\_\\\" after the \\\"wiki.freecad.org/\\\" is mandatory. If the name is used - you will see its content. In this case, you should choose another macro name. If name is available - you will see an empty page with a link at its end \\\"create this page\\\". Click it to create your page and paste into the empty entry field this snippet:\n\n {{Macro\n |Name=Macro_Template\n |Description=Minimum required text to publish the FreeCAD Addon.\n |Author=Screeneroner\n |Version=Template\n |Date=2023-09-28\n }}\n ==Script==\n {{MacroCode|code=\n <nowiki>\n __Name__ = \"Macro_Template\"\n __Comment__ = \"This page contains the minimum required text to publish the FreeCAD Addon\"\n __Author__ = \"Screeneroner\"\n __Version__ = \"Template\"\n __Date__ = \"2023-08-01\"\n __Help__ = \"Use this text to start publishing your macro\"\n\n print(\"Hello World!\")\n </nowiki>\n }}\n\n## 2. Code for pasting into [Addon Macro Repository](https://wiki.freecad.org/index.php?title=Macros_recipes) \n\n * [Macro Template](Macro_Template.md): Macro Template for the new macro wiki page.\n\n## Script\n\nThis is the real script that just prints text \\\"Hello World!\\\" in the FreeCAD console. Once you create the wiki page about your macro and include it in Addon Manager Repository, you may install it and verify that the installed version of \\'your\\' macro really makes the given printout. If all working fine - you may start replacing dummy print with your real code.\n\n\n{{MacroCode|code=\n__Name__ = \"Macro_Template\"\n__Comment__ = \"This page contains the minimum required text to publish the FreeCAD Addon\"\n__Author__ = \"Screeneroner\"\n__Version__ = \"Template\"\n__Date__ = \"2023-08-01\"\n__Help__ = \"Use this text to start publishing your macro\"\n\nprint(\"Hello World!\")\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Macro Template\n"}
{"id": "freecad-docs:wiki/Macro_Wiki_Object_Properties_List_Generator_Basic_Version.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Wiki_Object_Properties_List_Generator_Basic_Version.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Wiki_Object_Properties_List_Generator_Basic_Version.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "493efc8c8be19b6dac80358f11f9a5c3da46889022bed54f1b42be7431df4034", "bytes": 8935, "tokens": 2673, "text": "# Macro Wiki Object Properties List Generator Basic Version\n{{Macro\n|Name=Wiki List Generator of Object Properties\n|Description=This macro generate properties list of selected object. List presented in wiki format into Python report view.\n|Author=Evgeniy\n|Date=2021-09\n|Version=0.1\n|SeeAlso=[Macro Wiki Object Properties List Generator](Macro_Wiki_Object_Properties_List_Generator.md)\n}}\n\n## Description\n\nThis simple macro generate properties list of selected object. The parameters list is printed to the [Report view](Report_view.md) of FreeCAD. This example is more educational in nature and is not applicable for use without editing after generate, since it includes absolutely all the parameters of the object. The lists of properties that are published in this wiki contain, as a rule, only unique parameters. The parameters inherited from the parents objects are not published.\n\n## Usage\n\n- Preparing:\n - Copy code of Macro from this page and place it in a new \\*.FCMacro file.\n - Save FCMacro file, and place it in the FreeCAD Macros folder.\n - Disable **Include a timecode for each entry** checkbox in Preferences -\\> General -\\> Output window (Tab).\n- First using:\n - Select (or create and select) object the type of you need in tree view.\n - Select Macro -\\> Macros\\... item in main menu.\n - In opened window find \\*.FCMacro file what you save letter and press **Execute** Button.\n- How to use again:\n - To quickly run this macro again, you can use keyboard shortcut **Shift+Ctrl+1** (on Windows) it will launch the last run macro.\n\n## Recommendations\n\nDo not delete spaces between lines. This is necessary to simplify the translation. Each line separated by a space will be considered a separate part for translation. When creating texts, always remember that large monolithic fragments of text are difficult for translators to translate.\n\n## Example of using \n\n- For example open the Arch Workbench\n- Create a Structure object.\n- Select the created Structure object.\n- Run the macro.\n- Copy the text from the report view and paste it in a wiki page and check the result.\n\n## Results of using \n\nThe results may look like this:\n\n\n## Properties\n\n### View\n\n- **Proxy|PythonObject**:\n\n\n{{TitleProperty|Component}}\n\n- **UseMaterialColor|Bool**: Use the material color as this object\\'s shape color, if available\n\n\n{{TitleProperty|Display Options}}\n\n- **BoundingBox|Bool**: Display object bounding box\n\n- **DisplayMode|Enumeration**: Set the display mode\n\n- **ShowInTree|Bool**: Show the object in the tree view\n\n- **Visibility|Bool**: Show the object in the 3d view\n\n\n{{TitleProperty|Nodes}}\n\n- **NodeColor|Color**: The color of the nodes line\n\n- **NodeLine|Float**: The width of the nodes line\n\n- **NodeSize|Float**: The size of the node points\n\n- **NodeType|Enumeration**: The type of structural node\n\n- **ShowNodes|Bool**: If the nodes are visible or not\n\n\n{{TitleProperty|Object Style}}\n\n- **AngularDeflection|Angle**: Specify how finely to generate the mesh for rendering on screen or when exporting.\n\nThe default value is 28.5 degrees, or 0.5 radians. The smaller the value the smoother the appearance in the 3D view, and the finer the mesh that will be exported.\n\n- **Deviation|FloatConstraint**: Sets the accuracy of the polygonal representation of the model\n\nin the 3D view (tessellation). Lower values indicate better quality. The value is in percent of object\\'s size.\n\n- **DiffuseColor|ColorList**: Object diffuse color.\n\n- **DrawStyle|Enumeration**: Defines the style of the edges in the 3D view.\n\n- **Lighting|Enumeration**: Set object lighting.\n\n- **LineColor|Color**: Set object line color.\n\n- **LineColorArray|ColorList**: Object line color array.\n\n- **LineMaterial|Material**: Object line material.\n\n- **LineWidth|FloatConstraint**: Set object line width.\n\n- **PointColor|Color**: Set object point color\n\n- **PointColorArray|ColorList**: Object point color array.\n\n- **PointMaterial|Material**: Object point material.\n\n- **PointSize|FloatConstraint**: Set object point size.\n\n- **ShapeColor|Color**: Set shape color\n\n- **ShapeMaterial|Material**: Shape material\n\n- **Transparency|Percent**: Set object transparency\n\n\n{{TitleProperty|Selection}}\n\n- **OnTopWhenSelected|Enumeration**: Enabled: Display the object on top of any other object when selected\n\nObject: On top only if the whole object is selected Element: On top only if some sub-element of the object is selected\n\n- **Selectable|Bool**: Set if the object is selectable in the 3d view\n\n- **SelectionStyle|Enumeration**: Set the object selection style\n\n### Data\n\n- **Placement|Placement**:\n\n- **Proxy|PythonObject**:\n\n- **Shape|Part::PropertyPartShape**:\n\n- **Visibility|Bool**:\n\n\n{{TitleProperty|Base}}\n\n- **ExpressionEngine|ExpressionEngine|Hidden**: Property expressions\n\n- **Label|String**: User name of the object (UTF8)\n\n- **Label2|String|Hidden**: User description of the object (UTF8)\n\n\n{{TitleProperty|Component}}\n\n- **Additions|LinkList**: Other shapes that are appended to this object\n\n- **Axis|Link**: An optional axis or axis system on which this object should be duplicated\n\n- **Base|Link**: The base object this component is built upon\n\n- **CloneOf|Link**: The object this component is cloning\n\n- **HiRes|Link**: An optional higher-resolution mesh or shape for this object\n\n- **HorizontalArea|Area**: The area of the projection of this object onto the XY plane\n\n- **Material|Link**: A material for this object\n\n- **MoveBase|Bool**: Specifies if moving this object moves its base instead\n\n- **MoveWithHost|Bool**: Specifies if this object must move together when its host is moved\n\n- **PerimeterLength|Length**: The perimeter length of the horizontal area\n\n- **StandardCode|String**: An optional standard (OmniClass, etc\\...) code for this component\n\n- **Subtractions|LinkList**: Other shapes that are subtracted from this object\n\n- **VerticalArea|Area**: The area of all vertical faces of this object\n\n\n{{TitleProperty|IFC}}\n\n- **IfcData|Map**: IFC data\n\n- **IfcProperties|Map**: IFC properties of this object\n\n- **IfcType|Enumeration**: The type of this object\n\n\n{{TitleProperty|IFC Attributes}}\n\n- **Description|String**: Description of IFC attributes are not yet implemented\n\n- **GlobalId|String**: Description of IFC attributes are not yet implemented\n\n- **ObjectType|String**: Description of IFC attributes are not yet implemented\n\n- **PredefinedType|Enumeration**: Description of IFC attributes are not yet implemented\n\n- **Tag|String**: Description of IFC attributes are not yet implemented\n\n\n{{TitleProperty|Structure}}\n\n- **FaceMaker|Enumeration**: The facemaker type to use to build the profile of this object\n\n- **Height|Length**: The height or extrusion depth of this element. Keep 0 for automatic\n\n- **Length|Length**: The length of this element, if not based on a profile\n\n- **Nodes|VectorList**: The structural nodes of this element\n\n- **NodesOffset|Distance**: Offset distance between the centerline and the nodes line\n\n- **Normal|Vector**: The normal extrusion direction of this object (keep (0,0,0) for automatic normal)\n\n- **Profile|String**: A description of the standard profile this element is based upon\n\n- **Tool|Link**: An optional extrusion path for this element\n\n- **Width|Length**: The width of this element, if not based on a profile\n\n\n## Script\n\n {{MacroCode|code= \n#! python\n# -*- coding: utf-8 -*-\n# (c) 2021 <Evgeniy> LG\nfrom FreeCAD import Qt\n\ndef print_obj_properties(obj,typ):\n prop={}\n i=1\n for pr in obj.PropertiesList:\n tp = obj.getTypeIdOfProperty(pr) or \"\"\n atr = obj.getTypeOfProperty(pr) or (\"\")\n # Wiki template supports only Hidden type of property. But it can be as: Hidden,Output,Readonly etc...\n if atr != \"\" and atr[0] == \"Hidden\":\n atr = \"|\"+atr[0]\n else:\n atr = \"\" \n prop[str(i)] = pr,obj.getGroupOfProperty(pr),tp.replace(\"App::Property\",\"\"),obj.getDocumentationOfProperty(pr),atr\n i+=1\n sorted_prop = sorted(prop.items(), key=lambda x: x[1][1])\n\n title=\"\"\n for pr in sorted_prop:\n if title != pr[1][1]:\n title = pr[1][1]\n print(\"\\n\"+\"{{TitleProperty{\"+title+\"}}\")\n print(\"\\n\"+\"* {{Property\"+typ+\"{\"+pr[1][0]+\"{\"+pr[1][2]+pr[1][4]+\"}}: \"+pr[1][3])\n\nprint(\"\\n\"+\"==Properties==\")\nprint(\"\\n\"+\"===View===\")\nobj = Gui.activeDocument().ActiveObject\nprint_obj_properties(obj,\"View\")\nprint(\"\\n\"+\"===Data===\")\nobj = FreeCAD.activeDocument().ActiveObject\nprint_obj_properties(obj,\"Data\")\n\n}}\n\n## Links\n\nThe discussion on the forum: \n\n\n---\n⏵ [documentation index](../README.md) > Macro Wiki Object Properties List Generator Basic Version\n"}
{"id": "freecad-docs:wiki/Macro_Z_height_map.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Z_height_map.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Z_height_map.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2530880fb961dc4d19b08108a2ef6e902de09b4c60cdb9404670c8ad78cb835c", "bytes": 146, "tokens": 63, "text": "# Macro Z height map\n1. REDIRECT [Macro_Z_Height_Map](Macro_Z_Height_Map.md)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Z height map\n"}
{"id": "freecad-docs:wiki/Mesh_Difference.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_Difference.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_Difference.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "42ebd813e2a3925510c597a4a6c4491cf67a7fd600f05f92ff0fb384375fcfa2", "bytes": 1377, "tokens": 444, "text": "---\n GuiCommand:\n Name: Mesh Difference\n MenuLocation: Meshes , Boolean , Difference\n Workbenches: Mesh_Workbench\n SeeAlso: Mesh_Union, Mesh_Intersection\n---\n\n# Mesh Difference\n\n## Description\n\nThe **Mesh Difference** command creates a new non-parametric mesh object, a [Mesh Feature](Mesh_Feature.md), that is the difference of two mesh objects: one mesh object is cut from the other.\n\n[OpenSCAD](http://www.openscad.org/) must be installed to use this command, and the path to its executable must be set in the [OpenSCAD preferences](OpenSCAD_Preferences.md).\n\n  \n*On the left two mesh objects, on the right the mesh object that is the difference of those objects if the cube is selected as the main object*\n\n## Usage\n\n1. Select the main mesh object.\n2. Add the mesh object you want to cut from the main object to the selection. The mesh objects must overlap.\n3. There are several ways to invoke the command:\n - Press the ** [Difference](Mesh_Difference.md)** button.\n - Select the **Meshes → Boolean → Difference** option from the menu.\n\n## Properties\n\nSee: [Mesh Feature](Mesh_Feature.md).\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh Difference\n"}
{"id": "freecad-docs:wiki/Mesh_Evaluation.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_Evaluation.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_Evaluation.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a6941876cce8e7d159cf205b63fb299e7bc2fe91cd80d2804ced27a65e4889dc", "bytes": 3455, "tokens": 1018, "text": "---\n GuiCommand:\n Name: Mesh Evaluation\n MenuLocation: Meshes , Analyze , Evaluate and repair mesh...\n Workbenches: Mesh_Workbench\n---\n\n# Mesh Evaluation\n\n## Description\n\nThe **Mesh Evaluation** command evaluates and repairs a mesh object.\n\n \n*The Evaluate & Repair Mesh dialog box with the Folds on surface option enabled*\n\n## Usage\n\n1. Optionally select a single mesh object.\n2. There are several ways to invoke the command:\n - Press the ** [Evaluate and repair mesh...](Mesh_Evaluation.md)** button.\n - Select the **Meshes → Analyze → Evaluate and repair mesh...** option from the menu.\n3. The **Evaluate & Repair Mesh** dialog box opens.\n4. Optionally press the **Settings...** button to change the following settings:\n - \n **Check for non-manifold points**\n \n\n - \n **Enable check for folds on surface**\n \n\n - \n **Only consider zero area faces as degenerated**\n \n5. If you have not yet selected a mesh object: select one from the dropdown list at the top of the dialog box.\n6. The dialog contains 7 or 8 (if the **Folds on surface** option is enabled) test options.\n7. Do not use the checkboxes, they will be checked automatically if errors are found.\n8. Press any of the **Analyze** buttons to start a test.\n9. Or use the **Analyze** button from the **All above tests together** option to run all 7 or 8 tests together.\n10. Errors will be indicated in the dialog box, and also, with yellow and red markers, in the [3D view](3D_view.md).\n11. Optionally press one or more **Repair** buttons to repair the errors that were found.\n12. Optionally press the **Reset** button to reset all test results. This will reset the dialog and remove the colored markers from the 3D view. If you want to repeat the same test or run all tests together there is no need to do this.\n13. Optionally select a different mesh object from the dropdown list to continue testing and repairing.\n14. Press the **Close** button to close the dialog box and finish the command.\n15. The **Refresh** button does not work properly at this time.\n\n## Notes\n\n- Repairing a mesh can mean that problematic elements are deleted from the mesh resulting in holes. Holes can be closed with the [Mesh FillupHoles](Mesh_FillupHoles.md), [Mesh FillInteractiveHole](Mesh_FillInteractiveHole.md) and [Mesh AddFacet](Mesh_AddFacet.md) commands.\n- See [this forum post](https://forum.freecadweb.org/viewtopic.php?f=3&p=533252#p533252) for an explanation of the mesh data structure. This information may help to understand why a mesh has problems.\n\n## Preferences\n\n- The **Check for non-manifold points** setting is stored: **Tools → Edit parameters... → BaseApp → Preferences → Mod → Mesh → Evaluation → CheckNonManifoldPoints**.\n- The **Enable check for folds on surface** setting is stored: **Tools → Edit parameters... → BaseApp → Preferences → Mod → Mesh → Evaluation → EnableFoldsCheck**.\n- The **Only consider zero area faces as degenerated** setting is stored: **Tools → Edit parameters... → BaseApp → Preferences → Mod → Mesh → Evaluation → StrictlyDegenerated**.\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh Evaluation\n"}
{"id": "freecad-docs:wiki/Mesh_FillHoles.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_FillHoles.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_FillHoles.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "64ae3c15f2b65261846c6d49ddfef9e20590e25e0b4f702bbaa8128257d3937a", "bytes": 162, "tokens": 77, "text": "# Mesh FillHoles\n1. REDIRECT [Mesh_FillupHoles](Mesh_FillupHoles.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh FillHoles\n"}
{"id": "freecad-docs:wiki/Mesh_FlipNormals.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_FlipNormals.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_FlipNormals.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "fff031b980363db2d8008048b63d1134eefcd1b50cb8f1891f313d034e87fd12", "bytes": 1122, "tokens": 371, "text": "---\n GuiCommand:\n Name: Mesh FlipNormals\n MenuLocation: Meshes , Flip normals\n Workbenches: Mesh_Workbench\n SeeAlso: Mesh_HarmonizeNormals\n---\n\n# Mesh FlipNormals\n\n## Description\n\nThe **Mesh FlipNormals** command reverses, flips, the normals of mesh objects.\n\n## Usage\n\n1. Select one or more mesh objects.\n2. There are several ways to invoke the command:\n - Press the ** [Flip normals](Mesh_FlipNormals.md)** button.\n - Select the **Meshes → Flip normals** option from the menu.\n\n## Notes\n\n- For a clear indication of the orientation of the faces of mesh objects make sure the **Lighting** property of the mesh objects is set to {{Value|One side}}. The color of the back side of their faces will then depend on the backlight settings: **Edit → Preferences... → Display → 3D View → Backlight color - Intensity**. See: [Preferences Editor](Preferences_Editor#3D_View.md).\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh FlipNormals\n"}
{"id": "freecad-docs:wiki/Mesh_RemoveComponents.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_RemoveComponents.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_RemoveComponents.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d403dbdcb3cbe66ab2d317bab99e3f70104960220e7f98eea5f4af4244a36ab6", "bytes": 2620, "tokens": 742, "text": "---\n GuiCommand:\n Name: Mesh_RemoveComponents\n MenuLocation: Meshes , Remove components...\n Workbenches: Mesh_Workbench\n SeeAlso: Mesh_RemoveCompByHand, Arch_SplitMesh\n---\n\n# Mesh RemoveComponents\n\n## Description\n\nThe **Mesh RemoveComponents** command removes faces from mesh objects.\n\n \n*The Remove components task panel*\n\n## Usage\n\n1. The command uses the color red to mark selected faces. To see them properly:\n - The **Display Mode** of the mesh objects ideally should be {{Value|Flat lines}}, but should at least show faces. If necessary use the [Std DrawStyle](Std_DrawStyle.md) command to override this property.\n - The **Shape Color** of the mesh objects should not be red.\n2. There are several ways to invoke the command:\n - Press the ** [Remove components...](Mesh_RemoveComponents.md)** button.\n - Select the **Meshes → Remove components...** option from the menu.\n3. The **Remove components** task panel opens.\n4. Use one or more of the **Select** options to select faces:\n - Press the **Region** button and while holding down the left mouse button draw a region, a closed spline, in the [3D view](3D_view.md). Faces that match the **Region options** and (partially) fall inside the region will be selected.\n - Press the **All** button to select all faces.\n - Press the **Components** button to select all components with fewer than the specified maximum number of faces. Here a component refers to a complete group of connected faces. Usually a mesh object contains a single component. But, for example after using the [Mesh Merge](Mesh_Merge.md) command, a mesh object can contain multiple components.\n - Press the **Pick triangle** button to select a single face in the 3D view. If the **Select whole component** option is checked, selecting a face will result in selecting the entire component the face belongs to.\n5. Optionally use one or more of the **Deselect** options to deselect faces. These options are identical to the **Select** options, except that the number of faces for the **Components** button is a minimum number.\n6. Optionally press the **Invert** button to invert the selection.\n7. Press the **Delete** button to delete the selected faces.\n8. Press the **Close** button to close the task panel and finish the command.\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh RemoveComponents\n"}
{"id": "freecad-docs:wiki/Mesh_SectionByPlane.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_SectionByPlane.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_SectionByPlane.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7aee63962bed52b92918b677b65d8b3b443202b589160f8f5e4e2a3da7ce3cf8", "bytes": 1792, "tokens": 640, "text": "---\n GuiCommand:\n Name: Mesh SectionByPlane\n MenuLocation: Meshes , Cutting , Create section from mesh and plane\n Workbenches: Mesh_Workbench\n SeeAlso: Mesh_CrossSections\n---\n\n# Mesh SectionByPlane\n\n## Description\n\nThe **Mesh SectionByPlane** command creates a cross section across a mesh object. The cross section is a [Part Feature](Part_Feature.md).\n\n## Usage\n\n1. Select a single mesh object and a single [Part plane](Part_Primitives.md). The (extended) plane should intersect the mesh object.\n2. There are several ways to invoke the command:\n - Press the ** [Create section from mesh and plane](Mesh_SectionByPlane.md)** button.\n - Select the **Meshes → Cutting → Create section from mesh and plane** option from the menu.\n\n## Properties\n\nSee: [Part Feature](Part_Feature.md).\n\n## Scripting\n\nSee also: [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nTo section a mesh use its `section` method. The method requires a second mesh object that need not be planar.\n\n \n```python\nimport FreeCAD as App\nimport Mesh\nimport Part\n\n# Create a non-parametric box-shaped mesh:\nmsh = App.ActiveDocument.addObject(\"Mesh::Feature\", \"Mesh\")\nmsh.Mesh = Mesh.createBox(30, 40, 50)\nmsh.ViewObject.DisplayMode = \"Flat Lines\"\n\n# Create a planar mesh from 3 points:\np1 = App.Vector(-20, -60, 0)\np2 = App.Vector(65, 25, 0)\np3 = App.Vector(-20, 25, 0)\nmsh_plane = Mesh.Mesh([p1, p2, p3])\n\n# Find the section loops (each loop is a list of points):\nloops = msh.Mesh.section(msh_plane)\n\n# Show the loop polygon:\nPart.show(Part.makePolygon(loops[0]))\n```\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh SectionByPlane\n"}
{"id": "freecad-docs:wiki/Mesh_SegmentationBestFit.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_SegmentationBestFit.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_SegmentationBestFit.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "5fdd01c30a4c0b2f19da5ab6abc2b5c05ff7872a6cceb9f375ce9b499da29ede", "bytes": 2711, "tokens": 776, "text": "---\n GuiCommand:\n Name: Mesh SegmentationBestFit\n MenuLocation: Meshes , Create mesh segments from best-fit surfaces...\n Workbenches: Mesh_Workbench\n SeeAlso: Mesh_Segmentation\n---\n\n# Mesh SegmentationBestFit\n\n## Description\n\nThe **Mesh SegmentationBestFit** command creates separate mesh segments for specified surface types of a mesh object. The command can also identify their parameters which can be useful when re-engineering a mesh object.\n\n## Usage\n\n1. If you plan to identify the parameters of a surface type, note that the command uses the color red to mark the faces selected for this option. To see them properly:\n - The **Display Mode** of the mesh object ideally should be {{Value|Flat lines}}, but should at least show faces. If necessary use the [Std DrawStyle](Std_DrawStyle.md) command to override this property.\n - The **Shape Color** of the mesh object should not be red.\n2. Select a single mesh object.\n3. There are several ways to invoke the command:\n - Press the ** [Create mesh segments from best-fit surfaces...](Mesh_SegmentationBestFit.md)** button.\n - Select the **Meshes → Create mesh segments from best-fit surfaces...** option from the menu.\n4. The **Mesh segmentation** task panel opens.\n5. Optionally press one of the **Parameters...** buttons to identify the parameters of a surface:\n - The **Surface fit** dialog box opens.\n - Select one or more faces belonging to the surface:\n - Press the **Region** button and while holding down the left mouse button draw a region, a closed spline, in the [3D view](3D_view.md). Faces that (partially) fall inside the region will be selected.\n - Press the **Triangle** button to select individual faces.\n - Optionally press the **Clear** button to clear the selection.\n - Press the **Compute** button to calculate the parameters.\n - Press the **OK** or **Cancel** button to close the dialog box.\n6. Select the surface type(s) you wish to create mesh segments for:\n - \n **Plane**\n \n\n - \n **Cylinder**\n \n\n - \n **Sphere**\n \n7. Specify the **Tolerance** values.\n8. Specify the **Minimum number of faces** values.\n9. Press the **OK** button.\n10. The command will create a [group](Std_Group.md) containing separate mesh objects, each a segment of the original mesh object.\n11. If the created group is empty try using the command again with modified settings.\n\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh SegmentationBestFit\n"}
{"id": "freecad-docs:wiki/Mesh_to_Part.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_to_Part.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_to_Part.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "60321b1afba8c75d31111f1ad196653243b3ee7116d4108896bb631b1aa30f47", "bytes": 3764, "tokens": 1098, "text": "# Mesh to Part\n## Convert Part objects to meshes \n\nConverting higher-level objects such as [Part](Part_Workbench.md) shapes to simpler objects such as [meshes](Mesh_Workbench.md) is a pretty straightforward operation where all faces of a Part object get triangulated. The result of that triangulation (tessellation) is then used to construct a mesh:\n\n \n```python\nimport Mesh\n\nobj = FreeCADGui.Selection.getSelection()[0] # a Part object must be preselected\nshp = obj.Shape\nfaces = []\n\ntriangles = shp.tessellate(1) # the number represents the precision of the tessellation\nfor tri in triangles[1]:\n face = []\n for i in tri:\n face.append(triangles[0][i])\n faces.append(face)\n\nm = Mesh.Mesh(faces)\nMesh.show(m)\n```\n\nAlternative example:\n\n \n```python\nimport Mesh\nimport MeshPart\n\nobj = FreeCADGui.Selection.getSelection()[0] # a Part object must be preselected\nshp = obj.Shape\n\nmesh = FreeCAD.ActiveDocument.addObject(\"Mesh::Feature\", \"Mesh\")\nmesh.Mesh = MeshPart.meshFromShape(\n Shape=shp,\n LinearDeflection=0.01,\n AngularDeflection=0.025,\n Relative=False)\n```\n\n## Convert meshes to Part objects \n\nConverting meshes to Part objects is a common operation. Very often you will receive 3D data in a mesh format. Meshes are quite practical for representing free-form geometry and big visual scenes, as they are very lightweight. But in FreeCAD we generally prefer higher-level objects, solids, that can carry much more information and allow for curved faces.\n\nConverting meshes to those higher-level objects (handled by the [Part Workbench](Part_Workbench.md) in FreeCAD) is not an easy operation. Meshes can contain thousands of triangles (for example when generated by a 3D scanner), and solids made of the same number of faces would be extremely difficult to manipulate. So you generally want to optimize the object when converting.\n\nFreeCAD currently offers two methods to convert meshes to Part objects. The first method is a simple, direct conversion without any optimization:\n\n \n```python\nimport Mesh\nimport Part\n\nmesh = Mesh.createTorus()\nshape = Part.Shape()\nshape.makeShapeFromMesh(mesh.Topology, 0.05) # the second arg is the tolerance for sewing\nsolid = Part.makeSolid(shape)\nPart.show(solid)\n```\n\nThe second method offers the possibility to consider mesh facets co-planar when the angle between them is under a certain value, reducing the number of faces in the final result:\n\n \n```python\nimport Mesh\nimport Part\nimport MeshPart\n\nobj = FreeCADGui.Selection.getSelection()[0] # a Mesh object must be preselected\nmesh = obj.Mesh\nsegments = mesh.getPlanarSegments(0.00001) # use rather strict tolerance here\nfaces = []\n\nfor i in segments:\n if len(i) > 0:\n # a segment can have inner holes\n wires = MeshPart.wireFromSegment(mesh, i)\n # we assume that the exterior boundary is that one with the biggest bounding box\n if len(wires) > 0:\n ext = None\n max_length=0\n for i in wires:\n if i.BoundBox.DiagonalLength > max_length:\n max_length = i.BoundBox.DiagonalLength\n ext = i\n\n wires.remove(ext)\n # all interior wires mark a hole and must reverse their orientation, otherwise Part.Face fails\n for i in wires:\n i.reverse()\n\n # make sure that the exterior wires comes as first in the list\n wires.insert(0, ext)\n faces.append(Part.Face(wires))\n\nsolid = Part.Solid(Part.Shell(faces))\nPart.show(solid)\n```\n\n {{Mesh Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Python Code](Category_Python%20Code.md) > [Mesh](Mesh_Workbench.md) > Mesh to Part\n"}
{"id": "freecad-docs:wiki/OpenSCAD_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/OpenSCAD_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/OpenSCAD_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4e1615e402f987bd6dbb480aa5d30c64dbe128e8dcec18d5a26c5f3c13790966", "bytes": 9442, "tokens": 2846, "text": "# OpenSCAD Workbench\n\n \n\n## Introduction\n\nThe [OpenSCAD Workbench](OpenSCAD_Workbench.md) is intended to offer interoperability with the open source software [OpenSCAD](http://www.openscad.org/). This program is not distributed as part of FreeCAD, but should be installed to make full use of this workbench. OpenSCAD should not be confused with [OpenCASCADE](OpenCASCADE.md), which is the geometrical kernel that FreeCAD uses to build geometry on screen. The OpenCASCADE libraries are always needed to use FreeCAD, while the OpenSCAD executable is entirely optional.\n\nIt contains a [CSG](OpenSCAD_CSG.md) importer to open the CSG files from OpenSCAD, and an exporter to output a CSG based tree. Geometry which is not based on CSG operations will be exported as a mesh.\n\nThis workbench contains functions to modify the CSG feature tree and repair models. It also contains general purpose tools that do not require installation of OpenSCAD; they can be used in conjunction with other workbenches. For example, the [Mesh Workbench](Mesh_Workbench.md) internally uses the OpenSCAD functions to perform operations with [meshes](mesh.md), as they are quite robust.\n\n  \n\n## Dependencies\n\nIn FreeCAD 0.19, the Ply (Python-Lex-Yacc) module, which is used to import CSG files, was removed from the FreeCAD source code, as it is a third party library not developed by FreeCAD. As a result, you now need to install Ply before using the OpenSCAD Workbench. When using a pre-packaged, stable version of FreeCAD this dependency should be installed automatically in all platforms; in other cases, for example, when [compiling](Compiling.md) from source, you may have to install it from an online repository.\n\nIn openSUSE this is done by:\n\n \n```python\nsudo zypper install python3-ply\n```\n\nIn Debian/Ubuntu based systems this is done like the following:\n\n \n```python\nsudo apt install python3-ply\n```\n\nThe general installation in all platforms can be done from the Python package index.\n\n \n```python\npip3 install --user ply\n```\n\n## OpenSCAD language and file format \n\nThe OpenSCAD language allows the use of variables and loops. It allows you to specify sub-modules to reuse geometry and code. This high degree of flexibility makes parsing very complex. Currently the OpenSCAD Workbench cannot handle the OpenSCAD language natively. Instead, if OpenSCAD is installed, it can be used to convert the input to the CSG format, which is a subset of the OpenSCAD language, and can be used as the input to OpenSCAD for further processing. During conversion all parametric behavior is lost, meaning that all variable names are discarded, loops expanded, and mathematical expressions evaluated.\n\n## Tools\n\n- [Color Code Shape](OpenSCAD_ColorCodeShape.md): Change the color of selected or all shapes based on their validity.\n- [Replace Object](OpenSCAD_ReplaceObject.md): Replace an object in the feature tree.\n- [Remove Subtree](OpenSCAD_RemoveSubtree.md): Removes the selected objects and all children that are not referenced from other objects.\n- [Refine Shape Feature](OpenSCAD_RefineShapeFeature.md): Cleans unnecessary lines.\n- [Mirror Mesh Feature](OpenSCAD_MirrorMeshFeature.md): Create Mirror Mesh Feature.\n- [Scale Mesh Feature](OpenSCAD_ScaleMeshFeature.md): Scale a Mesh Feature.\n- [Resize Mesh Feature](OpenSCAD_ResizeMeshFeature.md): Resize a Mesh Feature.\n- [Increase Tolerance Feature](OpenSCAD_IncreaseToleranceFeature.md): Increases tolerance of edges/faces/vertex of selected object(s).\n- [Convert Edges To Faces](OpenSCAD_Edgestofaces.md): Convert edges to faces. Useful to prepare imported DXF geometry for extrusion.\n- [Expand Placements](OpenSCAD_ExpandPlacements.md): Expand all placements downwards the FeatureTree.\n- [Explode Group](OpenSCAD_ExplodeGroup.md): Explodes fused part primitives.\n- [Add OpenSCAD Element](OpenSCAD_AddOpenSCADElement.md): Add an OpenSCAD element by entering OpenSCAD code into the task panel.\n- [Mesh Boolean](OpenSCAD_MeshBoolean.md): Creates new mesh object by boolean operation from shapes.\n- [Hull](OpenSCAD_Hull.md): Applies a hull to selected shapes.\n- [Minkowski](OpenSCAD_Minkowski.md): Applies a minkowski sum to selected shapes.\n\n## Preferences\n\n- [Preferences](OpenSCAD_Preferences.md): preferences available for the OpenSCAD tools.\n\n## Limitations\n\nOpenSCAD creates constructive solid geometry, as well as imports mesh files and extrudes 2D geometry from [DXF](DXF.md) files. FreeCAD allows you to create CSG with primitives as well. The FreeCAD geometry kernel (OCCT) works using a boundary representation. Therefore conversion from CSG to BREP should, in theory, be possible whereas conversion from BREP to CSG is, in general, not.\n\nOpenSCAD works internally on meshes. Some operations which are useful on meshes are not meaningful on a BREP model and can not be fully supported. Among these are convex hull, minkowski sum, glide and subdiv. Currently we run the OpenSCAD binary in order to perform hull and minkwoski operations and import the result. This means that the involved geometry will be triangulated. In OpenSCAD non-uniform scaling is often used, which does not impose any problems when using meshes. In our geometry kernel geometric primitives (lines, circular sections, etc) are converted to BSpline prior to performing such deformations. Those BSplines are known to cause trouble in later boolean operations. An automatic solution is not available at the moment. Please feel free to post to the forum if you encounter such problems. Often such problems can be solved be remodeling small parts. A deformation of a cylinder can substituted by an extrusion of an ellipses.\n\n## Importing text \n\nImporting OpenSCAD code with texts requires that the fonts that are used are properly installed on your system. You can verify this by opening OpenSCAD as a standalone tool and checking the list in **Help → Font List**. The list will also give you the correct font names. If a font does not appear in the list after installing, you may have to manually copy the font file to the appropriate system directory.\n\nImporting texts is relatively slow. Behind the scenes FreeCAD uses a DXF file created by OpenSCAD. The more contours there are the slower the import.\n\nIt can be a good idea to first import a simple test case (replace {{Incode|NameOfFont}} with the correct font name):\n\n\n TESTFONT=\"NameOfFont\";\n linear_extrude(0.001) {\n text(\"A\", size=5, font=TESTFONT, script=\"Latn\");\n };\n\n\nThe {{Incode|script=\"Latn\"}} parameter can be left out here, but is required if the text string does not contain any letters, but only punctuation and/or numbers.\n\nPlease note that {{Incode|use ;}} statements in your source files are ignored when importing in FreeCAD. Under OpenSCAD the effect of a {{Incode|use}} statement is that the provided font file is temporarily added to the list of known fonts (although even there the statement does not work when a script is modified interactively).\n\n## Hints\n\nWhen importing [DXF](DXF.md) set the Draft precision to a sensible amount as this will affect the detection of connected edges.\n\nIf FreeCAD crashes when importing CSG, it is strongly recommended that you enable \\\"automatically check model after boolean operation\\\" in **Menu → Edit → Preferences → Part Design → Model setting**.\n\n## Tutorials\n\n- [Import OpenSCAD code](Import_OpenSCAD_code.md)\n\n## Links\n\n- The official OpenSCAD project source code repository hosted on [GitHub](https://github.com/openscad/openscad)\n- Open tickets tagged \\\"OpenSCAD\\\" on the [FreeCAD Github issue tracker](https://github.com/FreeCAD/FreeCAD/labels/WB%20OpenSCAD). There are also tickets on the now archived [mantis bugtracker](https://freecadweb.org/tracker/search.php?tag_string=OpenSCAD).\n- Models tagged with \\\"OpenSCAD\\\" on [Thingiverse](http://www.thingiverse.com/tag:openscad)\n\n\n {{OpenSCAD Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [OpenSCAD](Category_OpenSCAD.md) > OpenSCAD Workbench\n"}
{"id": "freecad-docs:wiki/PDF.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PDF.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PDF.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f6179249965d55f62b5baa0fb20a47b349b2024d15d26b381c38a717e39faabe", "bytes": 1740, "tokens": 539, "text": "# PDF\n## Description\n\n[Portable Document Format](https://en.wikipedia.org/wiki/PDF) (PDF) is a file format developed by Adobe in the 1990s to present documents, including text and images.\n\nPDF is based on the PostScript language, which is a vector-based format to describe pages. In this sense it\\'s similar to [SVG](SVG.md), as it allows scaling a drawing to any size without losing its shape or amount of details.\n\nNevertheless, a PDF can contain many things, including text, fonts, vector graphics, and [bitmap](bitmap.md) images. PDF was standardized as an open format in 2008, as ISO 32000.\n\nPDF is commonly used as a sharing format, that is, to share documents, text, or images, that will display and print exactly as the author intended.\n\n## Usage\n\nAs FreeCAD is based on the Qt graphical toolkit, it can export the [3D view](3D_view.md) natively to PDF. This can be useful to export carefully created drawings that other users don\\'t need to modify. For example, pages created with the [TechDraw Workbench](TechDraw_Workbench.md) can be [exported](Std_Export.md) in this way for sharing or printing. In many cases it is also possible to perform two way conversion between PDF and [SVG](SVG.md).\n\nThe option to export to PDF is available in the **File → [Export PDF](Std_Export.md)** menu.\n\n## Related\n\n- See also: [Std Export](Std_Export.md) and [Std PrintPdf](Std_PrintPdf.md).\n\n- For [power users](Power_users_hub.md), there is an option to utilize the [Python console](Python_console.md) to export a PDF.\n\n\n---\n⏵ [documentation index](../README.md) > [File_Formats](Category_File_Formats.md) > PDF\n"}
{"id": "freecad-docs:wiki/PartDesign_AdditivePipe.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_AdditivePipe.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_AdditivePipe.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "61674a685890d347055ae9baf3f0aab7e604cea675cc0daaff8002a200642ca5", "bytes": 8074, "tokens": 2330, "text": "---\n GuiCommand:\n Name: PartDesign AdditivePipe\n MenuLocation: Part Design , Create an additive feature , Additive pipe\n Workbenches: PartDesign_Workbench\n Version: 0.17\n SeeAlso: PartDesign_AdditiveLoft, PartDesign_SubtractivePipe\n---\n\n# PartDesign AdditivePipe\n\n## Description\n\n**Additive Pipe** creates a solid in the active Body by sweeping one or more sketches (also referred to as cross-sections) along an open or closed path. If the Body already contains features, the additive pipe will be merged to them.\n\n  \n*On the left: cross-sections (A) and (B) to be swept along path (C); resulting Additive pipe on the right.*\n\n## Usage\n\nThe example image above shows two different cross-section shapes. The text below will describe the procedure with a single shape only. This will achieve a part with the same cross-section along the whole path.\n\n1. Create two separate sketches;\n - one for the path, e.g two lines connected by a curve as in the image above,\n - one for the cross-section shape, e.g. a circle as the first shape in the image above. Instead of a sketch also the face of a 3D object can be used. ((v0.20) )\n2. **Arrange** the two shapes in 3D correctly. It is recommended to place the origin of the cross-section onto the line of the path. The two sketches should in most cases be **orthogonal**. This can be done with the \\'Map Mode\\' function (make both sketches visible with **Space**. Select the cross-section sketch. Select Properties/DataTab/MapMode. Click the appearing **...** button at the right side. In the Attachment Dialog select a vertex of the path sketch and select the correct mode to get the two sketches aligned correctly.\n3. There are several ways to invoke the tool:\n - Press the ** [Additive pipe](PartDesign_AdditivePipe.md)** button.\n - Select the **PartDesign → Create an additive feature → Additive pipe** option from the menu.\n4. In the **Select feature** dialog select a sketch to be used as a cross-section and click **OK**.\n - Alternatively, a sketch or a face of a 3D object ((v0.20) ) can be selected before starting the tool. You will not get this dialog then.\n5. In the **Pipe parameters** under **Path to sweep along**, press the **Object** button.\n6. Select the sketch to be used as a path in the 3D view. In this case, the whole sketch will be used as a path.\n - Alternatively, single edges of the sketch can be selected by pressing **Add Edge** and selecting edges in the 3D view. Note that you must press the **Add Edge** for each edge again. You must select a continuous line with no branches.\n7. The other settings should work with the default settings in most cases.\n8. Click **OK**.\n\nTo use more than one cross-section, start with the first cross-section sketch as described above. Then under **Section transformation** set the Transform mode to *Multisection*; press **Add Section** then select a sketch in the [3D view](3D_view.md). Repeat for each additional cross-section.\n\n## Options\n\n**Section Transformation**:\n\n- Select **Constant** to use a single profile\n- Select **Multisection** to use multiple profiles\n\n**Section Orientation**:\n\n- Standard\n\n : This keeps the cross-section shape perpendicular to the path. This is the default setting.\n- Fixed\n - Orientation set by the first profile and constant throughout. This deactivates the alignment to the path normal vector. That means that the cross-section shape will not rotate with the path. Sweep along a circle to see the effect.\n- Frenet\n - Create minimum possible twisting of profile. For more info, see [Frenet-Serret Formulas](https://en.wikipedia.org/wiki/Frenet%E2%80%93Serret_formulas)\n- Auxiliary\n - Specify secondary path to guide pipe.\n - For each point **P** along the sweep path, there will be a corresponding point **Q** on the auxiliary path.\n - As the profile is swept, it will be transformed such that the **PQ** line is the normal of the sweep path.\n - If **Curvelinear equivalence** is set, then the **Q** points are scaled proportionally along the sweep path, regardless of its length.\n- Binormal\n - Specify binormal vector in X, Y and Z\n\n**Corner Transition**\n\n- Transformed\n- Right\n- Rounded\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nA PartDesign AdditivePipe object is derived from a [Part Feature](Part_Feature.md) object and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{TitleProperty|Base}}\n\n- **Add Sub Shape|PartShape|Hidden**:\n\n- **Base Feature|Link|Hidden**:\n\n- **_Body|LinkHidden|Hidden**:\n\n\n{{TitleProperty|Part Design}}\n\n- **Refine**: true or false. If set to true, cleans the solid from residual edges left by features. See [Part RefineShape](Part_RefineShape.md) for more details.\n\n\n{{TitleProperty|Sketch Based}}\n\n- **Profile|LinkSub**: reference to sketch.\n\n- **Midplane|Bool**: extrude symmetrically to sketch face.\n\n- **Reversed|Bool**: reverses extrusion direction.\n\n- **Up To Face|LinkSub**: face where feature will end.\n\n- **Allow Multi Face|Bool**: allow multiple faces in profile.\n\n\n{{TitleProperty|Sweep}}\n\n- **Sections|LinkSubList**: lists the sections used.\n\n- **Spine|LinkSub**: spine (path) to sweep along.\n\n- **Spine Tangent|Bool**: true or false (default). True extends the spine to include tangent edges.\n\n- **Auxiliary Spine|LinkSub|Hidden**: secondary spine (path) to orient the Sweep.\n\n- **Auxiliary Spine Tangent|Bool**: true or false (default). True extends the auxiliary spine to include tangent edges.\n\n- **Auxiliary Curvelinear|Bool**: true or false (default). True calculates the normal between equidistant points on both spines.\n\n- **Mode|Enumeration**: profile mode. Options are *Fixed*, *Frenet*, *Auxiliary* or *Binormal*. See [Options](#Options.md).\n\n- **Binormal|Vector**: binormal vector for corresponding orientation mode.\n\n- **Transition|Enumeration**: transition mode. Options are *Transformed*, *Right Corner* or *Round Corner*.\n\n- **Transformation|Enumeration**: *Constant* uses a single cross-section. *Multisection* uses two or more cross-sections. *Linear*, *S-shape* and *Interpolation* are currently not functional.\n\n## Notes\n\n- To better control the shape of the pipe, it is recommended that all cross-sections have the same number of segments. For example, for a pipe between a rectangle and a circle, the circle should be broken down into 4 connected arcs.\n- You can pipe from or toward a single [vertex](Glossary#V.md) from a sketch or the body. (v0.20) \n- When you select a [vertex](Glossary#V.md) as section, it must be the last section of the pipe. Otherwise the pipe body would consist of two solids connected at a single point. This would violates the CAD kernel\\'s definition of a 3D object. You can change the order of the sections by dragging them in the list.\n- The path can only be from a single sketch, feature or ShapeBinder. In case you want to sweep along several edges from different sketches, use a [SubShapeBinder](PartDesign_SubShapeBinder.md).\n- The path must not contain branches or T-junctions etc. Loops are allowed.\n- It can lead to issues if the cross-section is not perpendicular to the path in 3D.\n- A cross-section cannot lie on the same plane as the one immediately preceding it.\n- The cross-sections must not contain disjoint or crossing loops.\n- If the sketch has inner geometry, then the order in which the sketch geometry is created should be the same for all sections. Either start all sections with the inner geometry, or start them all with the outer. Otherwise an invalid pipe will be created where inner and outer walls cross.\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign AdditivePipe\n"}
{"id": "freecad-docs:wiki/PartDesign_Boolean.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_Boolean.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_Boolean.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b8786a0da4f4fd385aac928a099b1230046bf7da13f8b5a6b438cd03336874a0", "bytes": 3386, "tokens": 972, "text": "---\n GuiCommand:\n Name: PartDesign Boolean\n MenuLocation: Part Design , Boolean operation\n Workbenches: PartDesign_Workbench\n Version: 0.17\n---\n\n# PartDesign Boolean\n\n## Description\n\n**PartDesign Boolean** imports one or more [PartDesign Bodies](PartDesign_Body.md) or [PartDesign Clones](PartDesign_Clone.md) (designated as \\\"tool bodies\\\") into the active PartDesign Body and applies a Boolean operation (fuse, cut or common).\n\n  \n\n\n*On the left: active body (A) with tool bodies (B) and (C); result on the right after a Boolean Cut.*\n\n## Usage\n\n1. [Activate the Body](PartDesign_Body#Active_status.md) which is to receive the Boolean feature. ***Note**: It is important that neither the active Body nor any of the features it contains be selected!*\n2. Press the ** [PartDesign Boolean](PartDesign_Boolean.md)** button.\n3. In **Boolean Parameters**, click on the **Add body** button. The active body temporarily disappears from the [3D view](3D_view.md) to facilitate tool body selection.\n4. In the 3D view, select the Body to use in the Boolean feature. Repeat to add more Bodies.\n5. Select the type of Boolean operation in the drop down menu (Fuse, Cut or Common)\n6. Click **OK**.\n\nAlternatively, objects can be selected prior to pressing the Boolean button. They will be added automatically. When pre-selecting you are not restricted to Bodies. [PartDesign ShapeBinder](PartDesign_ShapeBinder.md), [PartDesign SubShapeBinder](PartDesign_SubShapeBinder.md) and even solids created with other workbenches can then also be selected.\n\n## Options\n\n- **Fuse:** merges the tool body or bodies to the active body.\n- **Cut:** subtracts the tool body or bodies from the active body.\n- **Common:** extracts the intersection from the selected body or bodies with the active body\n- Press the **Remove body** button to remove a body, by selecting it in the [3D view](3D_view.md).\n\n## Properties\n\n- **Type**: sets the Boolean operation (Fuse, Cut, Common)\n\n- **Label**: name given to the operation, this name can be changed at convenience.\n\n- **Group**: lists the tool bodies.\n\n- **Display**: sets the display between 2 modes:\n\n - Result (default): displays the result of the Boolean feature. In this mode, the tool Bodies cannot be displayed in their original state, even when their visibility is toggled on.\n - Tools: displays the tool Bodies in their original state. This mode is useful when tool Bodies need to be edited, or used in later operations.\n\n- **Selectable**: true or false. If set to false, the feature cannot be selected in the 3D view.\n\n- **Visibility**: true or false. Toggles the feature\\'s visibility in the 3D view.\n\n## Limitations\n\n- For Common to work with more than one tool body, they must all intersect each other along with the active Body.\n- Tool bodies adopt the local origin of the active Body. If the active Body is not located at (0,0,0) in the global coordinate system, the tool bodies\\' placement need to be relative to the active Body. It may be easier to leave the active Body\\'s placement at the origin before applying the Boolean feature, than to change its placement.\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign Boolean\n"}
{"id": "freecad-docs:wiki/PartDesign_Legacy.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_Legacy.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_Legacy.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b84b6fddac8a344a36460cf80f4cc48fc952f264a9c0b11715b971cdde644e6a", "bytes": 188, "tokens": 75, "text": "# PartDesign Legacy\n1. REDIRECT [PartDesign_Workbench](PartDesign_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign Legacy\n"}
{"id": "freecad-docs:wiki/PartDesign_Mirrored.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_Mirrored.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_Mirrored.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "07bbfb90a9f27d80e8fd5641ea9d3169028c44a1ff5ad49ed867b274f4a0ce65", "bytes": 4277, "tokens": 1262, "text": "---\n GuiCommand:\n Name: PartDesign Mirrored\n MenuLocation: Part Design , Apply a pattern , Mirrored\n Workbenches: PartDesign_Workbench\n SeeAlso: PartDesign_MultiTransform\n---\n\n# PartDesign Mirrored\n\n## Description\n\nThe **PartDesign Mirrored** tool mirrors one or more features.\n\n  \n*A Pocket feature created from a sketch containing a circle (A) is used to create a mirrored feature. The vertical axis of the sketch (B) is used to the define the mirror plane. The result (C) is shown on the right.*\n\n## Usage\n\n### Create\n\n1. Optionally [activate](PartDesign_Body#Active_status.md) the correct Body.\n2. Optionally select one or more features.\n3. There are several ways to invoke the tool:\n - Press the ** [Mirrored](PartDesign_Mirrored.md)** button.\n - Select the **Part Design → Apply a pattern → Mirrored** option from the menu.\n4. If there is no active Body, and there are two or more Bodies in the document, the **Active Body Required** dialog will open and prompt you to activate one. If there is a single Body it will be activated automatically.\n5. If no features were selected the **Select feature** [task panel](Task_panel.md) opens: select one or more (hold down the **Ctrl** key) from the list and press the **OK** button.\n6. The **Mirrored parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n7. Press the **OK** button to finish.\n\n### Edit\n\n1. Do one of the following:\n - Double-click the Mirrored object in the [Tree view](Tree_view.md).\n - Right-click the Mirrored object in the [Tree view](Tree_view.md) and select **Edit Mirrored** from the context menu.\n2. The **Mirrored parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n3. Press the **OK** button to finish.\n\n## Options\n\n- Choose the mode:\n - \n **Transform body**\n \n : Transforms the whole base feature\\'s shape (default). (v1.0) \n\n - \n **Transform tool shapes**\n \n : Transforms the individual tool shapes of selected features.\n\n - To add features:\n 1. Press the **Add feature** button.\n 2. Select a feature in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n 3. Repeat to add more features.\n - To remove features:\n 1. Press the **Remove feature** button.\n 2. Do one of the following:\n - Select a feature in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n - Select a feature in the list and press the **Del** key.\n - Right-click a feature in the list and select **Remove** from the context menu.\n 3. Repeat to remove more features.\n - If there are several features in the pattern, their order can be important. See [PartDesign PolarPattern](PartDesign_PolarPattern#Ordering_features.md).\n- Specify the mirror **Plane**:\n - \n **Vertical sketch axis**\n \n : The Y axis of the sketch (the plane passes through this reference and the Z axis of the sketch, only available for sketch-based features).\n\n - \n **Horizontal sketch axis**\n \n : The X axis of the sketch (idem).\n\n - \n **Construction line #**\n \n : A separate entry for each construction line in the sketch (idem).\n\n - \n **Base XY plane**\n \n : The XY plane of the Body.\n\n - \n **Base YZ plane**\n \n : The YZ plane of the Body.\n\n - \n **Base XZ plane**\n \n : The XZ plane of the Body.\n\n - \n **Select reference...**\n \n : Select a planar face in the [3D view](3D_view.md).\n- If the **Update view** checkbox is checked the view will update in real time.\n\n## Limitations\n\nSee [PartDesign PolarPattern](PartDesign_PolarPattern#Limitations.md).\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign Mirrored\n"}
{"id": "freecad-docs:wiki/PartDesign_PolarPattern.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_PolarPattern.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_PolarPattern.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1c0f57b17efa39ba68256b240d939b5f17c525c60ad70e8220235f38f9077484", "bytes": 6344, "tokens": 1820, "text": "---\n GuiCommand:\n Name: PartDesign PolarPattern\n MenuLocation: Part Design , Apply a pattern , PolarPattern\n Workbenches: PartDesign_Workbench\n SeeAlso: PartDesign_MultiTransform\n---\n\n# PartDesign PolarPattern\n\n## Description\n\nThe **PartDesign PolarPattern** tool creates a polar pattern of one or more features.\n\n  \n*A slot-shaped pocket (B) made on top of a base pad (A, also referred to as support) is used for a polar pattern. The result (C) is shown on the right.*\n\n## Usage\n\n### Create\n\n1. Optionally [activate](PartDesign_Body#Active_status.md) the correct Body.\n2. Optionally select one or more features in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n3. There are several ways to invoke the tool:\n - Press the ** [PolarPattern](PartDesign_PolarPattern.md)** button.\n - Select the **Part Design → Apply a pattern → PolarPattern** option from the menu.\n4. If there is no active Body, and there are two or more Bodies in the document, the **Active Body Required** dialog will open and prompt you to activate one. If there is a single Body it will be activated automatically.\n5. If no features were selected the **Select feature** [task panel](Task_panel.md) opens: select one or more (hold down the **Ctrl** key) from the list and press the **OK** button.\n6. The **PolarPattern parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n7. Press the **OK** button to finish.\n\n### Edit\n\n1. Do one of the following:\n - Double-click the PolarPattern object in the [Tree view](Tree_view.md).\n - Right-click the PolarPattern object in the [Tree view](Tree_view.md) and select **Edit PolarPattern** from the context menu.\n2. The **PolarPattern parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n3. Press the **OK** button to finish.\n\n## Options\n\n- Choose the mode:\n - \n **Transform body**\n \n : Transforms the whole base feature\\'s shape (default). (v1.0) \n\n - \n **Transform tool shapes**\n \n : Transforms the individual tool shapes of selected features.\n\n - To add features:\n 1. Press the **Add feature** button.\n 2. Select a feature in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n 3. Repeat to add more features.\n - To remove features:\n 1. Press the **Remove feature** button.\n 2. Do one of the following:\n - Select a feature in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n - Select a feature in the list and press the **Del** key.\n - Right-click a feature in the list and select **Remove** from the context menu.\n 3. Repeat to remove more features.\n - If there are several features in the pattern, their order can be important. See [Ordering features](#Ordering_features.md).\n\n- Specify the **Axis** of the pattern:\n - \n **Normal sketch axis**\n \n : The Z axis of the sketch (only available for sketch-based features).\n\n - \n **Vertical sketch axis**\n \n : The Y axis of the sketch (idem).\n\n - \n **Horizontal sketch axis**\n \n : The X axis of the sketch (idem).\n\n - \n **Construction line #**\n \n : A separate entry for each construction line in the sketch (idem).\n\n - \n **Base X axis**\n \n : The X axis of the Body.\n\n - \n **Base Y axis**\n \n : The Y axis of the Body.\n\n - \n **Base Z axis**\n \n : The Z axis of the Body.\n\n - \n **Select reference...**\n \n : Select a [Datum Line](PartDesign_Line.md) in the [Tree view](Tree_view.md) or a [Datum Line](PartDesign_Line.md) or edge in the [3D view](3D_view.md).\n\n- Check the **Reverse direction** checkbox to reverse the pattern.\n\n- (v1.0) : Specify the angle **Mode**:\n\n - \n **Overall Angle**\n \n : Enter the overall **Angle**. If the angle is less than 360°, the occurrences are evenly distributed from 0° (first occurrence) to the given angle (last occurrence). If the angle is 360°, the occurrences are evenly distributed around the circle. For n occurrences an angle of 360° is equivalent to an angle of 360°\\*(1-1/n).\n\n - \n (v1.0) \n \n : **Offset Angle**: Enter the **Offset** angle from a given point on the first occurrence to the same point on the next occurrence. For n occurrences: OverallAngle=(n-1)\\*Offset.\n\n- Specify the number of **Occurrences** (including the original feature).\n\n- If the **Update view** checkbox is checked the view will update in real time.\n\n## Ordering features \n\nIf some of the selected features are additive and others subtractive, their order can have have an impact on the final result. You can change the order by dragging individual features in the list.\n\n  \n*Effect of the feature order*\n\n## Limitations\n\n- Any shape in the pattern that does not overlap the parent feature will be excluded. This ensures that a PartDesign Body always consists of a single, connected solid.\n- The PartDesign patterns are not yet as optimized as their Draft counterparts. So for a large number of instances you should consider using a [Draft PolarArray](Draft_PolarArray.md) instead, combined with a Part boolean operation. This may require major changes to your model as you are leaving PartDesign and therefore cannot simply continue with further PartDesign features in the same body. An example is shown in [this Forum topic](https://forum.freecadweb.org/viewtopic.php?f=3&t=55192).\n- A pattern cannot be applied directly to another pattern, be it polar, linear or a mirror. For this you need a [PartDesign MultiTransform](PartDesign_MultiTransform.md).\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign PolarPattern\n"}
{"id": "freecad-docs:wiki/PartDesign_Revolution.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_Revolution.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_Revolution.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ea9193e75d237aba2d3ee4168b63ab8f3e1a0e17e9852cb9103a2487b9a89b7f", "bytes": 4546, "tokens": 1368, "text": "---\n GuiCommand:\n Name: PartDesign Revolution\n MenuLocation: Part Design , Create an additive feature , Revolution\n Workbenches: PartDesign_Workbench\n SeeAlso: PartDesign_Groove\n---\n\n# PartDesign Revolution\n\n## Description\n\nThe **Revolution** tool creates a solid by revolving a selected sketch or 2D object about a given axis.\n\n  \n\n\n*Above: sketch (A) is revolved 270 degrees counter-clockwise around axis (B); resulting solid (C) is shown right.*\n\n## Usage\n\n1. Select a single sketch or one or more faces from the Body.\n2. Press the ** [Revolution](PartDesign_Revolution.md)** button.\n3. Set the Revolution parameters, see [Options](#Options.md) below.\n4. Press the **OK** button.\n\n## Options\n\nWhen creating a revolution, or after double-clicking an existing revolution in the [Tree view](Tree_view.md), the **Revolution parameters** task panel is shown. It offers the following settings:\n\n\n\n### Type\n\n\n(v1.0) \n\nType offers five different ways of specifying the angle of the revolution:\n\n#### Dimension\n\nEnter a numeric value for the **Angle** of the revolution. With the option **Symmetric to plane** the revolution will extend half the given angle to either side of the sketch or face.\n\n#### To last \n\nThe revolution will extend up to the last face of the support it encounters in its direction. If there is no support, an error message will appear.\n\n#### To first \n\nThe revolution will extend up to the first face of the support it encounters in its direction. If there is no support, an error message will appear.\n\n#### Up to face \n\nThe revolution will extend up to a face. Press the **Face** button and select a face or a [datum plane](PartDesign_Plane.md) from the Body.\n\n#### Two dimensions \n\nThis allows to enter a second angle in which the revolution should extend in the opposite direction. The directions can be switched by checking the **Reversed** option.\n\n### Axis\n\nSpecifies the axis of the revolution:\n\n- **Vertical sketch axis**: selects the vertical sketch axis.\n- **Horizontal sketch axis**: selects the horizontal sketch axis.\n- **Construction line**: selects a construction line from the sketch used by the revolution. The dropdown list will contain an entry for each construction line. The first construction line will be labelled *Construction line 1*.\n- **Base (X/Y/Z) axis**: selects the X, Y or Z axis of the Body\\'s origin.\n- **Select reference\\...**: allows the selection of a straight edge or a [datum line](PartDesign_Line.md) from the Body.\n\nNote that when changing the axis, the **Reversed** option may be (un)checked automatically.\n\n### Angle\n\nDefines the angle of the revolution. This option is only available if **Type** is **Dimension** or **Two dimensions**. Angles larger than 360° are not possible. Nor are negative values, use the **Reversed** option instead.\n\n### Symmetric to plane \n\nCheck this option to extend the revolution half the given angle to either side of the sketch or face. This option is only available if **Type** is **Dimension**.\n\n### Reversed\n\nReverses the direction of the revolution.\n\n### 2nd angle \n\n\n(v1.0) \n\nDefines the angle of the revolution in the opposite direction. This option is only available if **Type** is **Two dimensions** and **Angle** is smaller than 360°.\n\n## Properties\n\n### Data\n\n\n{{TitleProperty|Part Design}}\n\n- **Refine|Bool**\n \n\n\n{{TitleProperty|Revolution}}\n\n- **Type|Enumeration**\n \n\n- **Base|Vector**: (read-only)\n\n- **Axis|Vector**: (read-only)\n\n- **Angle|Angle**\n \n\n- **Up To Face|LinkSub**\n \n\n- **Angle2|Angle**\n \n\n- **Reference Axis|LinkSub**\n \n\n\n{{TitleProperty|Sketch Based}}\n\n- **Profile|LinkSub**\n \n\n- **Midplane|Bool**\n \n\n- **Reversed|Bool**\n \n\n- **Allow Multi Face|Bool**\n \n\n## Notes\n\n- A [ShapeBinder](PartDesign_ShapeBinder.md) cannot be used for the profile.\n- When using a [SubShapeBinder](PartDesign_SubShapeBinder.md) for the profile, selecting the binder in the [Tree view](Tree_view.md) will fail, instead the binder\\'s face has to be selected in the [3D view](3D_view.md).\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign Revolution\n"}
{"id": "freecad-docs:wiki/PartDesign_Thickness.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_Thickness.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_Thickness.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2a4d4daafebb76cecf30ff2c363c07b9d461a7ec1f948234a563decad8e9ba55", "bytes": 6081, "tokens": 1836, "text": "---\n GuiCommand:\n Name: PartDesign Thickness\n MenuLocation: Part Design , Apply a dress-up feature , Thickness\n Workbenches: PartDesign_Workbench\n Version: 0.17\n SeeAlso: Part_Thickness\n---\n\n# PartDesign Thickness\n\n## Description\n\nThe **PartDesign Thickness** tool transforms a solid body into a hollow object with at least one open face, giving to each of its remaining faces a uniform thickness. It adds a **Thickness** object to the document with its corresponding representation in the [Tree view](Tree_view.md).\n\n \n*Base solid (A) → Solid with selected face to be opened (B) → Resulting hollow object (C)*\n\n## Usage\n\n### Add a thickness \n\n1. Optionally [activate](PartDesign_Body#Active_status.md) the Body to apply the Thickness to.\n2. Select one or more faces of the Body.\n3. There are several ways to invoke the tool:\n - Press the ** [Thickness](PartDesign_Thickness.md)** button.\n - Select the **Part Design → Apply a dress-up feature → Thickness** option from the menu.\n4. If there is no active Body, and there are two or more Bodies in the document, the **Active Body Required** dialog will open and prompt you to activate one. If there is a single Body it will be activated automatically.\n5. The **Thickness parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n6. Press the **OK** button to finish.\n\n: *Remember*:\n - Since there must be at least one face for the feature, the last remaining face in the list cannot be removed.\n\n### Edit a thickness \n\n1. Do one of the following:\n - Double-click the Thickness object in the [Tree view](Tree_view.md)\n - Right-click the Thickness object in the [Tree view](Tree_view.md) and select **Edit Thickness** from the context menu.\n2. The **Thickness parameters** [task panel](Task_panel.md) opens. See [Options](#Options.md) for more information.\n3. Press the **OK** button to finish.\n\n## Options\n\n- **Add face**: Add faces to the selection by pressing the **Add face** button and selecting more faces.\n\n- **Remove face**: Choose a way to remove faces from the selection:\n\n - Select one or more faces in the list and press the **Del** key or right-click the list and select **Remove** from the context menu.\n - Press the **Remove face** button. All previously selected faces are highlighted in purple. Select each face to be removed.\n\n- **Thickness**: Set the wall thickness either by editing the value or by clicking the up/down arrows.\n\n- **Mode**:\n\n - \n **Skin**\n \n : Select this option if you want to get an item like a vase, headless but with the bottom. Only this option can be selected.\n\n - \n **Pipe**\n \n : Not implemented. See [this forum topic](https://forum.freecadweb.org/viewtopic.php?p=484495#p484495).\n\n - \n **Recto Verso**\n \n : Not implemented. See [this forum topic](https://forum.freecadweb.org/viewtopic.php?p=484495#p484495).\n\n- **Join Type**:\n\n - \n **Arc**\n \n : When non-tangential faces are offset, new faces that do not intersect are joined by a fillet with a radius equal to the defined thickness.\n\n - \n **Intersection**\n \n : When non-tangential faces are offset, new faces that do not intersect are extended to meet at their virtual intersection.\n\n- **Intersection**: When checked, self-intersections in certain models are avoided. This option is not recommended as it relies on an incomplete [OpenCASCADE method](https://dev.opencascade.org/doc/refman/html/class_b_rep_offset_a_p_i___make_thick_solid.html#af78f35025a31e2ce8bd96c82fb33a981).\n\n- **Make thickness inwards**: When checked, faces are offset inward.\n\n## Notes\n\n- If thickness goes inwards, the value must be smaller than the smallest height of the Body.\n- The tool may fail with complex shapes. [Additive Pipe](PartDesign_AdditivePipe.md) or [Additive Loft](PartDesign_AdditiveLoft.md) may work better to create complex shapes.\n- Known errors:\n - BRep_API: command not done.\n - BRep_Tool: no parameter on edge.\n - Silently fails.\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nA PartDesign Thickness object is derived from a [Part Feature](Part_Feature.md) object and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{Properties_Title|Base}}\n\n- **Base|LinkSub**: Sub-link to the parent feature\\'s list of selected edges and faces.\n\n- **Support Transform|Bool**: Include the base additive/subtractive shape when used in pattern features. If disabled, only the dressed part of the shape is used for patterning. Default: `False`.\n\n- **Add Sub Shape|PartShape|hidden**\n \n\n- **Base Feature|Link|hidden**: Link to the parent feature.\n\n- **_ Body|LinkHidden|hidden**: Link to the parent body.\n\n\n{{Properties_Title|Part Design}}\n\n- **Refine|Bool**: Refine shape (clean up redundant edges) after adding/subtracting. The default value is determined by the **Automatically refine model after sketch-based operation** preference. See [PartDesign Preferences](PartDesign_Preferences#General.md).\n\n\n{{Properties_Title|Thickness}}\n\n- **Value|Length**: Thickness value. Default: {{value|1 mm}}.\n\n- **Mode|Enumeration**: Mode. {{value|Skin}} (default), {{value|Pipe}} or {{Value|Recto verso}}. Only {{value|Skin}} is implemented.\n\n- **Join|Enumeration**: Join type. {{value|Arc}} (default) or {{Value|Intersection}}.\n\n- **Reversed|Bool**: Apply the thickness towards the solids interior. Default: `False`.\n\n- **Intersection|Bool**: Enable intersection-handling. Default: `False`.\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign Thickness\n"}
{"id": "freecad-docs:wiki/Part_API.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_API.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_API.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7fecf7d0f45c22c4f1387fec523edbad899158ca7878c94cb430ba2cdfecbeec", "bytes": 5661, "tokens": 1827, "text": "# Part API\n**(November 2018) This information may be incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation] or [https://freecad-python-stubs.readthedocs.io/en/latest/autoapi/Part/ autogenerated Python Part API documentation].**\n\nThe Part module is the direct connection between FreeCAD and the OpenCasCade kernel. It provides mainly [TopoShapes](TopoShape_API.md) which is the main object type used by OpenCascade. The Part module also contains a variety of convenience functions to create and manipulate topoShapes. Example: \n```python\nimport Part\nmycube = Part.makeBox(2,2,2)\nPart.show(mycube)\n```\n\n\n{{APIFunction|__fromPythonOCC__|OCC.Object|Helper method to convert a pythonocc shape to an internal shape|A Part.Shape}}\n\n\n{{APIFunction|__sortEdges__|list of edges|Helper method to sort an unsorted list of edges so that afterwards the start and end vertex of two consecutive edges are geometrically coincident. It returns a single list of edges and the algorithm stops after the first set of connected edges which means that the output list can be smaller than the input list. The sorted list can be used to create a Wire.|a list of edges}}\n\n\n{{APIFunction|__toPythonOCC__|Part.Shape|Helper method to convert an internal shape to pythonocc shape|an OCC.Shape}}\n\n\n{{APIFunction|cast_to_shape|Part.Shape|Cast to the actual shape type| }}\n\n\n{{APIFunction|export|list,string|Export a list of objects into a single file.| }}\n\n\n{{APIFunction|getSortedClusters|list of edges|Helper method to sort and cluster a variety of edges| }}\n\n\n{{APIFunction|insert|string,string|Insert the file (path given as first argument) into the given document (second argument).| }}\n\n\n{{APIFunction|makeBox|length,width,height,[pnt,dir]|Makes a box located at pnt with the dimensions (length,width,height). By default pnt is Vector(0,0,0) and dir is Vector(0,0,1)|the created shape}}\n\n\n{{APIFunction|makeCircle|radius,[pnt,dir,angle1,angle2]|Makes a circle with a given radius. By default pnt is Vector(0,0,0), dir is Vector(0,0,1), angle1 is 0 and angle2 is 360|the created shape}}\n\n\n{{APIFunction|makeCompound|list|Creates a compound out of a list of shapes.|the created shape}}\n\n\n{{APIFunction|makeCone|radius1,radius2,height,[pnt,dir,angle]|Makes a cone with given radii and height. By default pnt is Vector(0,0,0), dir is Vector(0,0,1) and angle is 360|the created shape}}\n\n\n{{APIFunction|makeCylinder|radius,height,[pnt,dir,angle]|Makes a cylinder with a given radius and height. By default pnt is Vector(0,0,0),dir is Vector(0,0,1) and angle is 360|the created shape}}\n\n\n{{APIFunction|makeHelix|pitch,height,radius,[angle,lefthand,heightstyle]|Makes a helix shape with a given pitch, height and radius. Defaults to right-handed cylindrical helix. Non-zero angle parameter produces a conical helix. Lefthand True produces left handed helix. Heightstyle applies only to conical helices. Heightstyle False (default) will cause the height parameter to be interpreted as the length of the side of the underlying frustum. Heightstyle True will cause the height parameter to be interpreted as the vertical height of the helix. Pitch is \"metric pitch\" (advance/revolution). For conical helix, radius is the minor radius.|the created shape}}\n\n\n{{APIFunction|makeLine|(x1,y1,z1),(x2,y2,z2)|Makes a line of two points|the created shape}}\n\n\n{{APIFunction|makeLoft|shapelist,[boolean,boolean]|Creates a loft shape using the list of profiles. Optionally make result a solid (vs surface/shell) or make result a ruled surface.|the created shape}}\n\n\n{{APIFunction|makePlane|length,width,[pnt,dir]|Makes a plane. By default pnt is Vector(0,0,0) and dir is Vector(0,0,1)|the created shape}}\n\n\n{{APIFunction|makePolygon|list|Makes a polygon of a list of Vectors|the created shape}}\n\n\n{{APIFunction|makeRevolution|Curve,[vmin,vmax,angle,pnt,dir]|Makes a revolved shape by rotating the curve or a portion of it around an axis given by (pnt,dir). By default vmin/vmax are set to bounds of the curve,angle is 360,pnt is Vector(0,0,0) and dir is Vector(0,0,1)|the created shape}}\n\n\n{{APIFunction|makeRuledSurface|Edge or Wire,Edge or Wire|Creates a ruled surface out of two edges or wires. If wires are used then these must have the same number of edges.|the created shape}}\n\n\n{{APIFunction|makeShell|list|Creates a shell out of a list of faces. Note: Resulting shell should be manifold. Non-manifold shells are not well supported.|the created shape}}\n\n\n{{APIFunction|makeSolid|Part.Shape|Creates a solid out of the shells inside a shape.|the created shape}}\n\n\n{{APIFunction|makeSphere|radius,[center_pnt, axis_dir, V_startAngle, V_endAngle, U_angle]|Makes a sphere (or partial sphere) with a given radius. By default center_pnt is Vector(0,0,0), axis_dir is Vector(0,0,1), V_startAngle is 0, V_endAngle is 90 and U_angle is 360|the created shape}}\n\n\n{{APIFunction|makeTorus|radius1,radius2,[pnt,dir,angle1,angle2,angle]|Makes a torus with a given radii and angles. By default pnt is Vector(0,0,0),dir is Vector(0,0,1),angle1 is 0,angle2 is 360 and angle is 360|the created shape}}\n\n\n{{APIFunction|makeTube|edge,float|Creates a tube.|the created shape}}\n\n\n{{APIFunction|open|string|Creates a new document and load the file into the document.| }}\n\n\n{{APIFunction|read|string|Loads the file and return the shape.|a shape}}\n\n\n{{APIFunction|show|shape|Adds the shape to the active document or create one if no document exists.| }}\n\n\n---\n⏵ [documentation index](../README.md) > [API](Category_API.md) > [Poweruser Documentation](Category_Poweruser%20Documentation.md) > [Part](Part_Workbench.md) > Part API\n"}
{"id": "freecad-docs:wiki/Part_ColorPerFace.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_ColorPerFace.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_ColorPerFace.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "651765a7a3aad208358e1d5a2a758a49759b453144091d3e070a8e6c742a205e", "bytes": 2889, "tokens": 821, "text": "---\n GuiCommand:\n Name: Part ColorPerFace\n MenuLocation: View , Color per face\n Workbenches: Part_Workbench, PartDesign_Workbench\n SeeAlso: Std_SetAppearance\n---\n\n# Part ColorPerFace\n\n## Description\n\nThe **Part ColorPerFace** command sets the display properties of selected faces. To change a whole object use [Std SetAppearance](Std_SetAppearance.md) instead.\n\nThis page has been updated for version 1.0.\n\n  \n*The Set appearance per face task panel*\n\n## Usage\n\n1. Select a single object.\n2. There are several ways to invoke the command:\n - If the [Part Workbench](Part_Workbench.md) is active: press the ** [Color per face](Part_ColorPerFace.md)** button.\n - Select the **View → Color per face** option from the menu.\n - Select the ** Set appearance per face...** option from the [Tree view](Tree_view.md) context menu.\n3. The **Set appearance per face** task panel opens.\n4. Select one or more faces:\n - Hold down **Ctrl** to select mutliple faces.\n - Optionally press the **Box selection** button, click in an empty area and drag a rectangle to select all faces belonging to the object that are (partially) inside the rectangle. Multiple box selections can be specified.\n5. Do one of the following:\n - Select a material from the list.\n 1. Optionally press the **Launch editor** button to launch the [Materials editor](Materials_Edit.md).\n - Specify a **Custom appearance**:\n 1. Press the **...** button.\n 2. The **Material properties** dialog box opens:\n \n 3. These properties can be edited:\n - **Ambient color**: color of the shadows on the object.\n - **Diffuse color**: actual/base color of the object.\n - **Emissive color**: color of the light radiating from the object.\n - **Specular color**: color of the highlight (reflection) on a shiny surface of the object.\n - **Shininess**\n - **Transparency**\n 4. Optionally press the **Reset** button to change the appearance to that defined by the material.\n 5. Optionally press the **Default** button to change the appearance to match the current [preferences](PartDesign_Preferences#Shape_appearance.md).\n 6. Press the **Close** button when done.\n - Press the **Set to default** button to change the appearance to that defined by the material.\n6. Optionally select one or more new faces whose properties you want to change.\n7. Press the **OK** button to close the task panel and finish the command.\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part ColorPerFace\n"}
{"id": "freecad-docs:wiki/Part_CompCompoundTools.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_CompCompoundTools.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_CompCompoundTools.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e8a006c1dbe95bfff8ec6a4023d58d9668775b0c7818d1751e411e88c20c51e9", "bytes": 220, "tokens": 85, "text": "# Part CompCompoundTools\n1. REDIRECT [Part_Workbench#Part_CompCompoundTools](Part_Workbench#Part_CompCompoundTools.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part CompCompoundTools\n"}
{"id": "freecad-docs:wiki/Part_Compound.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_Compound.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_Compound.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3a5e661303e736e3f2fc90b322a9db13212a00fae2b78ef37bb7cbe48c2f99a7", "bytes": 1266, "tokens": 355, "text": "---\n GuiCommand:\n Name: Part Compound\n MenuLocation: Part , Make compound\n Workbenches: Part_Workbench\n Version: 0.14\n SeeAlso: Part_Fuse, Part_CompoundFilter, Part_ExplodeCompound\n---\n\n# Part Compound\n\n## Description\n\nThis command creates a compound of objects with a topological shape such as solid objects and other objects with faces and/or edges. It cannot handle meshes as they do not have a topological shape.\n\n## Usage\n\n1. Mark the topological shapes to be added to the compound in the [tree view](Tree_view.md)\n2. Choose **Part → Compound → Make Compound** entry in the Part menu or click on the button.\n\n## Notes\n\nA compound containing pieces that intersect or touch is **invalid** for Boolean operations. Because of performance issues, checking if the pieces intersect is not done by default. Automatic geometry check (available for Boolean operations) is disabled for part compound as well.\n\nTo turn this check on go to **Tools → Edit Parameters → Preferences... → Mod → Part → CheckGeometry → RunBOPCheck** and set the parameter to `true`.\n\n\n {{Part_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part Compound\n"}
{"id": "freecad-docs:wiki/Part_FaceColors.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_FaceColors.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_FaceColors.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0a0a9212966fcf1223dbc987a0fd77bbbe03f250118a3b8fa92ff6294a5f5bfb", "bytes": 166, "tokens": 67, "text": "# Part FaceColors\n1. REDIRECT [Part_ColorPerFace](Part_ColorPerFace.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part FaceColors\n"}
{"id": "freecad-docs:wiki/Part_Fuse.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_Fuse.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_Fuse.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "01a3b6788424f415c761678d442c6b07fb50c64572670a2baa219ab5e0ffa355", "bytes": 2204, "tokens": 670, "text": "---\n GuiCommand:\n Name: Part Fuse\n MenuLocation: Part , Boolean , Union\n Workbenches: Part_Workbench\n SeeAlso: Part_Boolean, Part_Cut, Part_Common\n---\n\n# Part Fuse\n\n## Description\n\nThe **_[Part_Fuse](Part_Fuse.md)** tool fuses (unites) selected Part objects into one. This operation is fully parametric and the components can be modified and the result recomputed.\n\n**Note:** This command is an automated form of the [Boolean operation](Part_Boolean.md).\n\n## Usage\n\n1. Select two or more shapes\n2. There are several ways to invoke the command:\n - Press the ** Part Fuse** button in the **Part tools** toolbar\n - Use the **Part → Boolean → Union** entry in the Part menu\n\n## Supported inputs \n\nInput objects must be [OpenCASCADE](OpenCASCADE.md) shapes. Examples: stuff made with Part, PartDesign, Sketcher workbenches. Not meshes (unless those were converted to shapes) - for meshes, there are specific Boolean tools in MeshDesign workbench.\n\n- Solid + Solid: the result is a solid that occupies all the volume covered by the inputs\n\n- Shell + Shell, Shell + Face, Face + Face: the result is a shell. Where faces intersect, they are split. Shells can be non-manifold. After fusion, faces can be united by [Refining](Part_RefineShape.md) the result.\n\n- Wire + Wire, Edge + Wire, Edge + Edge: the result is a wire. Edges are split where they intersect.\n\nCompounds are supported; however, it is assumed that shapes packed into a compound do not touch or intersect. If they actually do, Fusion will likely fail, or produce an incorrect result.\n\n## Options\n\nItems can be added and removed from a fusion, by dragging them in or out of the fusion feature in the tree view with the mouse. To drag items out of a fusion you have to drop them onto the document node (the filename) of your model. A manual recompute (press **F5** key or click on the [Refresh/Recompute](Std_Refresh.md) icon) is required to see the results.\n\n\n {{Part_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part Fuse\n"}
{"id": "freecad-docs:wiki/Part_MakeCompound.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_MakeCompound.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_MakeCompound.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6efb6ef7ebdf523d4f2b05ad3706c9a1ab7eb8a1af5024728a4a6a36407c3ddc", "bytes": 162, "tokens": 62, "text": "# Part MakeCompound\n1. REDIRECT [Part Compound](Part_Compound.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part MakeCompound\n"}
{"id": "freecad-docs:wiki/Part_Measure_Toggle_All.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_Measure_Toggle_All.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_Measure_Toggle_All.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4a223bc23d2f06e1e8f7bbf11764e27bbe5eb1e1441ad540d88476b17fd3d245", "bytes": 810, "tokens": 293, "text": "---\n GuiCommand:\n Name: Part Measure Toggle All\n MenuLocation: Measure , Toggle All\n Workbenches: Part_Workbench\n SeeAlso: Part_Measure_Toggle_3D, Part_Measure_Toggle_Delta\n---\n\n# Part Measure Toggle All\n\n## Description\n\nThis command toggles the visibility of all measurements in the [3D view](3D_view.md).\n\n \n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Toggle All](Part_Measure_Toggle_All.md)** button.\n - Select the **Measure → Toggle All** option from the menu.\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part Measure Toggle All\n"}
{"id": "freecad-docs:wiki/Part_Measure_Toggle_Delta.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_Measure_Toggle_Delta.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_Measure_Toggle_Delta.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e3bbf4b12a8d38d4abf44163aabc111fb0ff0ad0a62366217247fbb0e7aff9a6", "bytes": 756, "tokens": 267, "text": "---\n GuiCommand:\n Name: Part Measure Toggle Delta\n MenuLocation: Measure , Toggle Delta\n Workbenches: Part_Workbench\n SeeAlso: Part_Measure_Toggle_All, Part_Measure_Toggle_3D\n---\n\n# Part Measure Toggle Delta\n\n## Description\n\nThis command toggles the visibility of delta measurements in the [3D view](3D_view.md).\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Toggle Delta](Part_Measure_Toggle_Delta.md)** button.\n - Select the **Measure → Toggle Delta** option from the menu.\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part Measure Toggle Delta\n"}
{"id": "freecad-docs:wiki/Part_ProjectionOnSurface.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_ProjectionOnSurface.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_ProjectionOnSurface.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f88f181fd1addca8eba616f6736c6dd64554e638c2239e6d51b9ad8c236f554b", "bytes": 6350, "tokens": 1742, "text": "---\n GuiCommand:\n Name: Part ProjectionOnSurface\n MenuLocation: Part , Create projection on surface...\n Workbenches: Part_Workbench\n Version: 0.19\n---\n\n# Part ProjectionOnSurface\n\n## Description\n\n\n**[ [Part ProjectionOnSurface](Part_ProjectionOnSurface.md)**\n\nis used to project a [Shape](Shape.md) on top of a face from another object; this can be used to project a logo or textual object (see **[ [Draft ShapeString](Draft_ShapeString.md)**) onto different surfaces to create interesting effects.\n\nGiven a source [Shape](Shape.md), this tool can project edges, wires (closed edges), or entire faces from it; the result can be new edges, new wires, new faces, or even new extruded solids which can be used in [boolean operations](Part_Boolean.md) for effects such as engraving or stamping.\n\n \n\n\n*Projection of a logo on a curved surface.*\n\n## Usage\n\n1. Make sure you have at least two objects in your document; the \\\"source\\\" object that you wish to project, and the \\\"target\\\" object where the projection will be made.\n2. Click on **[ [Projection on surface](Part_ProjectionOnSurface.md)** to launch a [task panel](task_panel.md) with various options.\n3. Click on **Select projection surface**, and then click on the \\\"target\\\" surface where the projection will be created.\n4. Then click on the specific button to choose the type of subelement that you want to add to your projection object.\n - \n **Add face**\n \n : select a source face.\n\n - \n **Add wire**\n \n : select a source edge. The tool will extract the entire wire to which the edge belongs. For example, by choosing a single edge of a polygon, it will project the entire polygon.\n\n - \n **Add edge**\n \n : select a source edge. The tool will only project the selected edge.\n\n - Once a button is depressed, pick a subelement in the [3D view](3D_view.md). If you wish to deselect it, pick the same element again.\n\n - When you are satisfied with your selection, press the same **Add...** button to leave the selection mode.\n5. Then click on the specific radiobutton to choose the type of projection shape to create.\n - \n {{RadioButton|TRUE|Show all}}\n \n : it will show all types of closed wires and edges on the target surface. If a \\\"face\\\" subelement was selected in the previous step, a preview of a solid object extruded from the projection will be shown, depending on the value of **Extrude height**.\n\n - \n {{RadioButton|TRUE|Show faces}}\n \n : it will show a preview of a filled face on the target surface. This will only work if you selected a \\\"face\\\" subelement in the previous step; if you selected a closed \\\"wire\\\", only the edges (no face) will be created as projection; if you selected \\\"edges\\\", only those edges will be created as projection.\n\n - \n {{RadioButton|TRUE|Show edges}}\n \n : it will show a preview of the edges on the target surface. This will work whether you added a \\\"face\\\", \\\"wire\\\", or \\\"edge\\\" subelement in the previous step; even if you added a filled \\\"face\\\", only the edges will be created as projection.\n6. Press the **OK** to complete the operation and produce the new projection object.\n\nNotes:\n\n- The projection direction is automatically taken from the camera direction in the [3D view](3D_view.md) at the moment the tool is launched.\n- To change the direction, move the camera, and press **Get current camera direction**.\n- Alternatively press the **X:**, **Y:**, or **Z:** buttons to set the projection direction to the main global axes, +X, -X, +Y, -Y, +Z, or -Z.\n- However, do notice that changing the projection direction won\\'t automatically update the projection preview; in order to do this, you must re-select the geometry by pressing the **Add...** buttons and picking the subelements again.\n\n## Options\n\n- **Extrude height**: it is the height of the solid shape that is created by extruding the projected face, from the target surface and along the negative of the projection direction. For example, if the projection direction is along +Y {{Value|(0, 1, 0)}}, the extrusion will be created in the direction -Y {{Value|(0, -1, 0)}}. This solid extrusion will only be created if the subelement selected was a closed face, by pressing the **Add face** button, and by choosing the {{RadioButton|TRUE|Show all}} option.\n\n- **Solid depth**: it is the distance that the projection object is moved along the projection direction. Negative values will displace the object in the opposite direction; this allows creating a projection that is offset from the target surface.\n\n## Limitations\n\nThe projection algorithm sometimes is not able to create a valid projection face. If this happens a solid extrusion won\\'t be able to be created either.\n\nIf this happens:\n\n- Check if your source face is valid; try running the **[ [CheckGeometry](Part_CheckGeometry.md)** tool for clues.\n- Check if the projection direction is valid. Can the source face be realistically projected onto the target surface? Would a straight projection hit the surface? Adjust the camera so that the source face is in front of the target surface, and try again.\n- Try to use the {{RadioButton|TRUE|Show edges}} option. Are the edges projected correctly? Try to create a face with the edges by hand.\n\nThe projection done in the Part workbench is not parametric. If you need a parametric workflow, please consult with the [Projection class](https://gist.github.com/CsatiZoltan/f4fd10bf20923143ba0e0678ea1d3d61), which is a Python scripted object, intended for programmatic use.\n\n## Links\n\n- Forum thread: [Project faces onto bent surface](https://forum.freecadweb.org/viewtopic.php?f=9&t=33700)\n\n\n {{Part_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part ProjectionOnSurface\n"}
{"id": "freecad-docs:wiki/Part_Union.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_Union.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_Union.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7c92cbcfbb2cfbd83fb91ae8a7d534b94b4c06654002e98ae69acab1e9d6a6bd", "bytes": 140, "tokens": 59, "text": "# Part Union\n1. REDIRECT [Part_Fuse](Part_Fuse.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part Union\n"}
{"id": "freecad-docs:wiki/Path_Development_Roadmap.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_Development_Roadmap.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_Development_Roadmap.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "80d87e29157af71f0ff73169ad48866e1a5025ff7221ac6caa4226cb774e558c", "bytes": 168, "tokens": 57, "text": "# Path Development Roadmap\n1. REDIRECT [CAM Development Roadmap](CAM_Development_Roadmap.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path Development Roadmap\n"}
{"id": "freecad-docs:wiki/Path_SelectLoop.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_SelectLoop.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_SelectLoop.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "affee0177089a20726a23ce6f0ffd4d0fb300d59f94d3d69532c4d125d825067", "bytes": 132, "tokens": 55, "text": "# Path SelectLoop\n1. REDIRECT [CAM_SelectLoop](CAM_SelectLoop.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path SelectLoop\n"}
{"id": "freecad-docs:wiki/Path_ToolBitDock.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_ToolBitDock.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_ToolBitDock.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bf73084e0b25b9ef944313e98a011ef5e8c861060da52000b2a40ca0a7019c23", "bytes": 136, "tokens": 61, "text": "# Path ToolBitDock\n1. REDIRECT [CAM_ToolBitDock](CAM_ToolBitDock.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path ToolBitDock\n"}
{"id": "freecad-docs:wiki/Pivy.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Pivy.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Pivy.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a6ebab645fab0602307a3994044cf88d79a7b51f8cd736be988dfd0d5b567d60", "bytes": 6751, "tokens": 2102, "text": "# Pivy\n## Introduction\n\n[Pivy](Pivy.md) is a [Python](Python.md) binding library for [Coin](https://github.com/coin3d), the 3D-rendering library used in FreeCAD to display things in a [3D view](3D_view.md). Coin is an open source implementation of the \\\"Open Inventor\\\" specification to handle graphics. Therefore, in FreeCAD, the terms \\\"Pivy\\\", \\\"Coin\\\" or \\\"Open Inventor\\\" refer to the same thing essentially.\n\nWhen imported in a running Python interpreter, Pivy allows us to communicate directly with any running Coin [scenegraph](Scenegraph.md), such as the [3D view](3D_view.md), or even to create new ones. Pivy is not required to compile FreeCAD, but it is required at runtime when running Python-based workbenches that create shapes on screen, like [Draft](Draft_Workbench.md) and [BIM](BIM_Workbench.md). Because of this, Pivy is normally installed when installing a distribution of FreeCAD.\n\nThe Coin library is divided into several pieces, Coin itself for manipulating scenegraphs, and bindings for several GUI systems, such as Windows and Qt. If present on the system, those modules are available to Pivy as well. The Coin module is always present, and it is what we will use anyway, since we won\\'t need to care about anchoring our 3D display in any interface, that is already done by FreeCAD. All we need to do is this:\n\n \n```python\nfrom pivy import coin\n```\n\n## Scenegraph\n\nWe saw on the [Scenegraph](Scenegraph.md) page how a typical Coin scene is organized. Everything that appears in a [3D view](3D_view.md) is a Coin scenegraph, organized in the same way. We have one root node, and all objects on the screen are its children.\n\nFreeCAD has an easy way to access the root node of a 3D view scenegraph:\n\n \n```python\nsg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()\nprint(sg)\n```\n\nThis will return the root node:\n\n \n```python\n >\n```\n\nWe can inspect the immediate children of our scene:\n\n \n```python\nfor node in sg.getChildren():\n print(node)\n```\n\nSome of those nodes, such as `SoSeparator` or `SoGroup` nodes, can have children themselves. The complete list of the available Coin objects can be found in the official Coin documentation.\n\nLet\\'s try to add something to our scenegraph now. We\\'ll add a nice red cube:\n\n \n```python\ncol = coin.SoBaseColor()\ncol.rgb = (1, 0, 0)\ncub = coin.SoCube()\nmyCustomNode = coin.SoSeparator()\nmyCustomNode.addChild(col)\nmyCustomNode.addChild(cub)\nsg.addChild(myCustomNode)\n```\n\nNow, let\\'s try this:\n\n \n```python\ncol.rgb = (1, 1, 0)\n```\n\nAs you can see everything is still accessible and modifiable on-the-fly. No need to recompute or redraw anything, Coin takes care of everything. You can add stuff to your scenegraph, change properties, hide stuff, show temporary objects, anything. Of course, this only concerns the display in the 3D view. That display gets recomputed by FreeCAD on file open, and when an object needs recomputing. So, if you change the aspect of an existing FreeCAD object, those changes will be lost if the object gets recomputed or when you reopen the file.\n\nAs already mentioned, in an openInventor scenegraph the order is important. A node affects what comes next. For example, if we want to have the ability to move our cube we will need to add a `SoTranslation` node **before** the cube:\n\n \n```python\ncol = coin.SoBaseColor()\ncol.rgb = (1, 0, 0)\ntrans = coin.SoTranslation()\ntrans.translation.setValue([0, 0, 0])\ncub = coin.SoCube()\nmyCustomNode = coin.SoSeparator()\nmyCustomNode.addChild(col)\nmyCustomNode.addChild(trans)\nmyCustomNode.addChild(cub)\nsg.addChild(myCustomNode)\n```\n\nTo move our cube we can now do:\n\n \n```python\ntrans.translation.setValue([2, 0, 0])\n```\n\nFinally, removing something is done with:\n\n \n```python\nsg.removeChild(myCustomNode)\n```\n\n\n## Callbacks\n\nA [callback mechanism](http://en.wikipedia.org/wiki/Callback_%28computer_science%29) is a system that permits a library, such as our Coin library, to call you back, that is, to call a certain function from your currently running Python object. That way Coin can notify you that some specific event occurred in the scene. Coin can watch very different things, such as mouse position, mouse button clicks, keyboard keys being pressed, and many more.\n\nFreeCAD features an easy way to use such callbacks:\n\n \n```python\nfrom pivy import coin\n\nclass ButtonTest:\n def __init__(self):\n self.view = FreeCADGui.ActiveDocument.ActiveView\n self.callback = self.view.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.getMouseClick) \n\n def getMouseClick(self, event_cb):\n event = event_cb.getEvent()\n if event.getState() == coin.SoMouseButtonEvent.DOWN:\n print(\"Alert!!! A mouse button has been improperly clicked!!!\")\n self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.callback)\n\nButtonTest()\n```\n\nThe callback has to be initiated from an object, because that object must still be running when the callback occurs. See also a [complete list](Code_snippets#Observe_mouse_events_in_the_3D_viewer_via_Python.md) of possible events and their parameters, or the official Coin documentation.\n\n\n## Documentation\n\nUnfortunately, Pivy doesn\\'t have its own documentation. However, since it is an accurate wrapper of the Coin library, you can read the C++ reference for information. In this case, you need to translate the C++ class naming style to Python style.\n\nIn C++:\n\n \n```python\nSoFile::getClassTypeId()\n```\n\nIn Pivy:\n\n \n```python\nSoFile.getClassId()\n```\n\n- [Coin3D](https://github.com/coin3d) homepage.\n- [Pivy](https://github.com/coin3d/pivy) homepage.\n- [Coin3D wiki](https://github.com/coin3d/coin/wiki), at GitHub.\n- [Coin3D wiki documentation](https://github.com/coin3d/coin/wiki/Documentation), at GitHub.\n- [Coin3D Documentation](https://coin3d.github.io/Coin/html/), latest automatically generated Doxygen documentation.\n- [(Open)Inventor Mentor](https://webdocs.cs.ualberta.ca/~graphics/books/mentor.pdf) - recommended.\n\n### Older\n\nThese links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful.\n\n- [Coin3D Documentation](https://coin3d.bitbucket.io/Coin/index.html), at BitBucket.\n- [Coin3D Documentation](https://grey.colorado.edu/coin3d/index.html), at University of Colorado.\n- [Open Inventor Reference Documentation](https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html), by MeVisLab.\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Python Code](Category_Python%20Code.md) > Pivy\n"}
{"id": "freecad-docs:wiki/Points_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Points_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Points_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "50d72a88cddd3957e6ac55388b5775030f5936aebff863742b364cc2229397be", "bytes": 2807, "tokens": 972, "text": "# Points Workbench\n\n \n\n## Introduction\n\nThe [Points Workbench](Points_Workbench.md) offers specific tools for working with [point clouds](http://en.wikipedia.org/wiki/Point_cloud). The workbench is still in development.\n\nA point cloud is a collection of points in 3D space. A point cloud is generally produced by scanning the surface of a solid object. The cloud of points can then be used for many purposes including building a mesh for the object, reconstructing the surfaces and solid volumes, reverse engineering, as well as for visualization and quality inspection.\n\n## Tools\n\nAll Points Workbench tools can be accessed from the **Points** menu and the **Points tools** toolbar.\n\n- [Import points\\...](Points_Import.md): Imports a point cloud from a file.\n\n- [Export points\\...](Points_Export.md): Exports a point cloud to a file.\n\n- [Convert to points\\...](Points_Convert.md): Creates point clouds from shape objects.\n\n- [Structured point cloud](Points_Structure.md): Creates a structured point cloud from the points of an existing point cloud.\n\n- [Merge point clouds](Points_Merge.md): Creates a point cloud by combining the points of two or more point clouds.\n\n- [Cut point cloud](Points_PolyCut.md): Cuts points from point clouds.\n\n## Notes\n\n- [Draft](Draft_Workbench.md) commands such as [Draft Line](Draft_Line.md) and [Draft B-spline](Draft_BSpline.md) can be used to connect the points in a point cloud. Use [Draft Snap Endpoint](Draft_Snap_Endpoint.md) to snap to the points.\n- [Python](Python.md) can be used to analyze and process point clouds. See the following forum discussions:\n - [Inspecting Point cloud](http://forum.freecadweb.org/viewtopic.php?f=3&t=16098).\n - [Fläche aus Messwerten](http://forum.freecadweb.org/viewtopic.php?f=13&t=15988) (German)\n - [Schnitte durch Flächen aus Messwerten](http://forum.freecadweb.org/viewtopic.php?f=13&t=16103) (German)\n\n\n {{Points Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [Points](Category_Points.md) > Points Workbench\n"}
{"id": "freecad-docs:wiki/Preference_Packs.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Preference_Packs.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Preference_Packs.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "690f9077b58cc80dafb7d513cc7d7e78120e45c034b8eca2ba24b6ec97b233e3", "bytes": 14708, "tokens": 4536, "text": "# Preference Packs\n## Introduction\n\nA **Preference Pack** is a distributable collection of user preferences ((v0.20) ) that can be installed as an add-on and applied as a single set. Any user parameter that can be set in the user.cfg file can be included in a Preference Pack. Applying a preference pack sets all of the variables in the supplied CFG file without modifying any other user settings. For example, these packs can be used to create \\\"Themes\\\" by bundling together a custom stylesheet along with a set of user preferences that sets the various colors and styles of items in FreeCAD that aren\\'t controlled by the stylesheet.\n\n## Main Preference Packs user interface \n\nMost user interaction with installed Preference Packs is via the **General** tab in the **General settings** section of the [Preferences editor](Preferences_Editor.md).\n\n\n\n## Applying an installed pack \n\nTo apply a Preference Pack, click the **Apply** button next to its name in the **General** tab of the [Preferences editor](Preferences_Editor.md). The core of a Preference Pack is a set of user preferences. When applying a pack each of these preferences is changed to the value defined in the pack. Optionally, the pack author may have included a pre- and/or post-application macro that may also be run. Because packs can potentially make large (and possibly undesirable) changes to your user preferences, a timestamped backup of your original preferences is taken, and stored in **FREECAD_USER_DATA/SavedPreferencePacks/Backups**. These backups are retained for one week.\n\n## Creating a new pack \n\nPacks can be created by hand, or jump-started by using the **Save new...** button in the **General** tab of the [Preferences editor](Preferences_Editor.md). Clicking the button shows a dialog requesting a name for the new pack, and displays a set of checkboxes allowing only a subset of preferences to be stored.\n\n\n\nBecause of the way FreeCAD uses preferences internally, only items contained in these template files can be saved automatically using this procedure. Items not included in the template files must be manually included in the pack\\'s \\*.cfg file. There is no built-in limit to which preferences items may be included in a preference pack, but authors are strongly discouraged from changing a user\\'s set language, or from modifying the recent files list, or from changing anything related to a temporary UI state (e.g. the saved size of a resizable window, etc.).\n\n### Template details \n\nThese sections list all preferences contained in the built-in templates. Right now they are focused on appearance-related items, but pull requests and forum suggestions for additional inclusions are welcome. Installed Addons may also provide their own templates (not documented here). Click \\\"Expand\\\" on the far right of each entry to see the list.\n\n\n