{"id": "freecad-docs:wiki/3D_view.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/3D_view.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/3D_view.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "506eb46ed79150ad6db3a87e1a22bb0339e9ce0389f47cebfa7b8cc998520899", "bytes": 1663, "tokens": 522, "text": "# 3D view\n## Introduction\n\n \n\nThe [3D view](3D_view.md) of FreeCAD is an instance of a Coin3D [scenegraph](Scenegraph.md) that forms the most important window in the [interface](interface.md). Coin3D is a library that implements the OpenInventor 2.1 scene description standard.\n\nCertain properties of the view, like background color, [mouse navigation](Mouse_navigation.md) style, and zooming steps, can be configured in the [preferences editor](Preferences_Editor.md).\n\n\"\"\n\n\n*The [Draft Workbench](3D_view]]_is_a_component_of_the_FreeCAD_[[interface]]. By default it shows a small widget with coordinate axes, and the navigation cube also with coordinate axes; the grid can be displayed and configured by loading the [[Draft Workbench.md).*\n\n## Context menu \n\nThe options in the context menu of the 3D view depend on the selected object(s) and the currently active workbench. To display this menu optionally select one or more objects and then right-click in the 3D view.\n\n## Details\n\nFreeCAD uses the Quarter library to use Coin3D in a Qt environment.\n\nIt is possible to interact directly with the 3D view scenegraph from the [Python console](Python_console.md) by using the Python library Pivy.\n\nFor more information see the power user documentation:\n\n- [Scenegraph](Scenegraph.md), description of Coin3D.\n- [Pivy](Pivy.md), usage of Coin3D from the Python console.\n- [Third party libraries](Third_Party_Libraries.md) used by FreeCAD.\n- [Coin3D](https://grey.colorado.edu/coin3d/index.html) C++ documentation.\n\n {{Interface navi}}\n\n\n---\n⏵ [documentation index](../README.md) > 3D view\n"} {"id": "freecad-docs:wiki/API_documentation.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/API_documentation.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/API_documentation.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d1bd711f05ec2283df6741fe8ffcb7dfe34f226ecd557f9266e6869d0c8072ca", "bytes": 159, "tokens": 60, "text": "# API documentation\n1. REDIRECT [:Category:API](:Category_API.md)\n\n\n---\n⏵ [documentation index](../README.md) > [API](Category_API.md) > API documentation\n"} {"id": "freecad-docs:wiki/Advanced_FreeCAD_test_system.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Advanced_FreeCAD_test_system.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Advanced_FreeCAD_test_system.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "761176c060a8bb7b2b44595b71dd4fd2cf60ba737eb8e2680d060b2bb0e7cdd4", "bytes": 4774, "tokens": 1088, "text": "# Advanced FreeCAD test system\nThis page is dedicated to the Google Summer of Code project regarding the enhancement of FreeCAD\\'s test system.\n\n**Obsolete**: This page has been moved to \n\n## Outline\n\nFreeCAD as a CAE application has a high level of complexity, both in its source code and also in its user interaction. To ensure a certain level of quality automatic testing is essential. However, as an open source application with spare time coders only this part of the project has not seen very much attention. One of the major reasons is the low-level handling required to write test cases. All actions to trigger, every result fetching and every single comparison needs to be hand coded. This makes it cumbersome to provide a test for every created functionality and possibly impossible to do so if deep document comparisons are needed. For example the Part and PartDesign workbench: An automated test for document objects require the resulting topology shape to be analysed. This is a tremendous part and cannot be handled on a per test basis.\n\nThis project aims at reducing the work required to write meaningful tests. This should be accomplished by providing a infrastructure for result file storage and special \\\"comparators\\\" which compare the stored result files with the test result for equality.\n\n## Details\n\n1. Create a result file infrastructure for the test system. It should allow to save an arbitrary number of files together with the test itself where the expected results are stored. It is intended to have one result file for each comparator used. The infrastructure should make the storage (file structure), loading and handling easy. It furthermore should define a specification for the generic file content, e.g. which comparator to use for it etc.\n2. Create a infrastructure for comparators and provide a few important ones. The comparators should be able to read in a result file and compare the available test output with it. As every workbench requires different types of comparisons the comparators need to be provided by the workbench itself, as well as possible top-level ones. The test infrastructure needs to be adopted to work with such workbench specific types. Furthermore there needs to be a way to generate result files for comparators. this can be done either by themselves or by a different class.\n 1. Implement a global comparator for the document structure: It stores the Document object structure with all properties in a result file and compares the available document after a test run with it\n 2. Implement a Part workbench comparator for shapes: It stores data about a certain TopoShape in a result file suitable for comparison, e.g. number of edges/vertices/faces, properties like area, mass, center of gravity.\n 3. Advanced: Create a global comparator for the 3D output based on picture comparison. This is marked as advanced as this comparator needs to be tolerant to slight changes due to driver differences (see VTK for example) and also needs to somehow ensure the same display settings used for the comparators every time\n3. Create a wizard or GUI for test creation in the Test workbench. This would work like macro recording: the user starts the test recording, and everything plotted in the python console would be the test procedure. When hitting stop the user gets a dialog where he can choose which comparators to apply. The wizard than creates the appropriate test structure with the test itself, all needed result files etc.\n4. Create a Wiki page describing the working of the test system and how to create tests and new comparators\n\n## Expected Outcome \n\n1. Mergable code for a result file based comparator system\n2. A GUI for simplified test generation based on macro recording\n3. A Wiki page describing the procedure for the user to create tests and the developer to create new comparators\n4. Tests which utilize the created comparators and show their use\n\n## Future Possibilities \n\nFuture contributions can include new comparators, e.g. for meshes. Also creating tests for existing functionality has a high priority and can be achieved with the new system. Futhermore a GUI based system can be created, where a test is defined by recorded UI events, see [Record and replay events](http://algoholic.eu/recording-and-replaying-qt-input-events/). This could also be a new GSoC project.\n\n## Project Properties \n\n### Skills\n\n- Programming language mainly Python, some comparators may need C++ code.\n- Understand and use APIs from FreeCAD and external libraries (OCC for Part comparator)\n\n### Difficulty\n\nMedium\n\n### Project size \n\n175h\n\n### Additional Information\n\n\n---\n⏵ [documentation index](../README.md) > Advanced FreeCAD test system\n"} {"id": "freecad-docs:wiki/App_GeoFeature.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/App_GeoFeature.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/App_GeoFeature.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "55079c31a8660856a821b867d2fb9eed6f5e6427d64687714411619ddaea1168", "bytes": 6912, "tokens": 2131, "text": "# App GeoFeature\n## Introduction\n\n \"\" \n\nAn [App GeoFeature](App_GeoFeature.md) object, or formally an `App::GeoFeature`, is the base class of most objects that will display geometrical elements in the [3D view](3D_view.md) because it includes a **Placement** property.\n\n\"\"\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nThe [App GeoFeature](App_GeoFeature.md) is an internal object, so it cannot be created from the graphical interface. It is generally not meant to be used directly, rather it can be sub-classed to get a bare-bones object that only has a basic **Placement** property to define its position in the [3D view](3D_view.md).\n\nSome of the most important derived objects are the following:\n\n- The [Part Feature](Part_Feature.md) class, the parent of most objects with 2D and 3D [topological shapes](Part_TopoShape.md).\n- The [Mesh Feature](Mesh_Feature.md) class, the parent of most objects made from [meshes](Mesh_MeshObject.md), not solids.\n- The [Fem FemMeshObject](FEM_Mesh.md) class, the parent of finite element meshes created with the [FEM Workbench](FEM_Workbench.md).\n- The [CAM Feature](CAM_Feature.md) class, the parent of paths created with the [CAM Workbench](CAM_Workbench.md) for use in CNC machining.\n- The [App Part](App_Part.md) class, which defines [Std Parts](Std_Part.md) that can be used as containers of bodies to perform assemblies.\n\nWhen creating this object in [Python](Python.md), instead of sub-classing `App::GeoFeature`, you should sub-class `App::GeometryPython` because the latter includes a default view provider, and `Proxy` attributes for the object itself, and its view provider. See [Scripting](App_GeoFeature#Scripting.md).\n\n## Properties App GeoFeature \n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThe [App GeoFeature](App_GeoFeature.md) (`App::GeoFeature` class) is derived from the basic [App DocumentObject](App_DocumentObject.md) (`App::DocumentObject` class) and inherits all its properties. In addition it has a **Placement** property, which controls its position in the [3D view](3D_view.md).\n\n## Properties App GeometryPython \n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThe [App GeometryPython](App_GeoFeature.md) (`App::GeometryPython` class) is derived from the basic [App GeoFeature](App_GeoFeature.md) (`App::GeoFeature` class) and inherits all its properties. It also has several additional properties.\n\nThese are the properties available in the [property editor](Property_editor.md). Hidden properties can be shown by using the **Show all** command in the context menu of the [property editor](Property_editor.md).\n\n### Data\n\n\n{{TitleProperty|Base}}\n\n- **Proxy|PythonObject|Hidden**: a custom class associated with this object.\n\n- **Placement|Placement**: the position of the object in the [3D view](3D_view.md). The placement is defined by a `Base` point (vector), and a `Rotation` (axis and angle). See [Placement](Placement.md).\n\n - \n **Angle**\n \n : the angle of rotation around the **Axis**. By default, it is {{value|0°}} (zero degrees).\n\n - \n **Axis**\n \n : the unit vector that defines the axis of rotation for the placement. Each component is a floating point value between {{value|0}} and {{value|1}}. If any value is above {{value|1}}, the vector is normalized so that the magnitude of the vector is {{value|1}}. By default, it is the positive Z axis, {{value|(0, 0, 1)}}.\n\n - \n **Position**\n \n : a vector with the 3D coordinates of the base point. By default, it is the origin {{value|(0, 0, 0)}}.\n\n- **Label|String**: the user editable name of this object, it is an arbitrary UTF8 string.\n\n- **Label2|String|Hidden**: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|\"\"}}.\n\n- **Expression Engine|ExpressionEngine|Hidden**: a list of expressions. By default, it is empty {{value|[]}}.\n\n- **Visibility|Bool|Hidden**: whether to display the object or not.\n\n### View\n\n\n{{TitleProperty|Base}}\n\n- **Proxy|PythonObject|Hidden**: a custom [viewprovider](Viewprovider.md) class associated with this object.\n\n\n{{TitleProperty|Display Options}}\n\n- **Bounding Box|Bool**: if it is `True`, the object will show the bounding box in the [3D view](3D_view.md).\n\n- **Display Mode|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Show In Tree|Bool**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Visibility|Bool**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n\n{{TitleProperty|Object Style}}\n\n- **Shape Color|Color**: a tuple of three floating point RGB values light gray .\n\n- **Shape Material|Material|Hidden**: an [App Material](App_Material.md) associated with this object. By default it is empty.\n\n- **Transparency|Percent**: an integer from {{value|0}} to {{value|100}} that determines the level of transparency of the faces in the [3D view](3D_view.md). A value of {{value|100}} indicates completely invisible faces; the faces are invisible but they can still be picked as long as **Selectable** is `True`.\n\n\n{{TitleProperty|Selection}}\n\n- **On Top When Selected|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n- **Selectable|Bool**: if it is `True`, the object can be picked with the pointer in the [3D view](3D_view.md). Otherwise, the object cannot be selected until this option is set to `True`.\n\n- **Selection Style|Enumeration**: see the information in [App FeaturePython](App_FeaturePython.md).\n\n## Scripting\n\n\n**See also:**\n\n[FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md) and [scripted objects](Scripted_objects.md).\n\nSee [Part Feature](Part_Feature.md) for the general information on adding objects to the document.\n\nA GeoFeature is created with the `addObject()` method of the document. If you would like to create an object with a 2D or 3D [topological shape](Part_TopoShape.md), it may be better to create one of the sub-classes specialized for handling shapes, for example [Part Feature](Part_Feature.md) or [Part Part2DObject](Part_Part2DObject.md).\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::GeoFeature\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\nFor [Python](Python.md) subclassing you should create the `App::GeometryPython` object.\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::GeometryPython\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\n\n---\n⏵ [documentation index](../README.md) > App GeoFeature\n"} {"id": "freecad-docs:wiki/Arch_3DS.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_3DS.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_3DS.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ee21795e54457a5f41a59dd2a610a15a5ffc13c8addef4ff1908ca59dec6f0d2", "bytes": 485, "tokens": 144, "text": "# Arch 3DS\n## Description\n\nThe BIM Workbench supports importing [3DS](https://en.wikipedia.org/wiki/.3ds) files. The 3DS format is ancient but still widely used on the internet. It can contain mesh data and material information. At the moment, it will import mesh objects contained in the file as FreeCAD mesh objects, and has no support for materials yet.\n\n\n---\n⏵ [documentation index](../README.md) > [File Formats](Category_File%20Formats.md) > [BIM](Category_BIM.md) > Arch 3DS\n"} {"id": "freecad-docs:wiki/Arch_CutLine.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Arch_CutLine.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Arch_CutLine.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d87fd20211d28595f3f6479ee425f5e6197d23cba5fd9e5b15b2e0aaea4f582f", "bytes": 1599, "tokens": 522, "text": "---\n GuiCommand:\n Name: Arch CutLine\n MenuLocation: Arch , Cut with line\n Workbenches: Arch_Workbench\n Version: 0.19\n SeeAlso: Arch_CutPlane\n---\n\n# Arch CutLine\n\n## Description\n\nThe **Arch CutLine** tool cuts a solid Arch object like an [Arch Wall](Arch_Wall.md) or [Arch Structure](Arch_Structure.md) with a straight edge. Based on that edge and the normal of the [Draft working plane](Draft_SelectPlane.md) a cutting face is generated.\n\n \"\" \"\" \n\n\n*[Arch Wall](Arch_Wall.md) cut by a line. Left: subtractive box that appears when using the tool. Right: resulting wall after the cut is done.*\n\n## Usage\n\n1. If required align the working plane:\n - The selected edge may not be parallel to the normal of the working plane.\n - The generated cutting face will be perpendicular to the working plane.\n2. Select the object to be cut in the [Tree view](Tree_view.md) or the [3D view](3D_view.md).\n3. Select a straight edge. This must be selected in the [3D view](3D_view.md).\n4. Press the ** [Cut with line](Arch_CutLine.md)** button.\n5. Choose **Behind** or **Front** to indicate on which side of the cutting face material should be removed.\n6. Press the **OK** button.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch CutLine\n"} {"id": "freecad-docs:wiki/Artwork_Plot.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Artwork_Plot.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Artwork_Plot.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e17cd0faeaaf252037e225554277038caece51ec4aa90c27f5ab6154a8437c09", "bytes": 852, "tokens": 352, "text": "# Artwork Plot\nThese icons are in the indicated source path.\n\nFor all icons in the source tree, see [Artwork](Artwork.md).\n\n## Mod/Plot/\n\n### Mod/Plot/freecad/plot/resources/icons/\n\n \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\" \"\"\n\n\n---\n⏵ [documentation index](../README.md) > [Artwork](Category_Artwork.md) > [Plot](Category_Plot.md) > Artwork Plot\n"} {"id": "freecad-docs:wiki/Assembly3_AxialMove.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_AxialMove.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_AxialMove.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "288211f6a70b10d8ffc7a0b1b59ba2b2c83fd52e4e125042fd87f0bc3d94ecb2", "bytes": 1457, "tokens": 489, "text": "---\n GuiCommand:\n Name: Assembly3 AxialMove\n Icon: Assembly_AxialMove.svg\n MenuLocation: Assembly3 , Axial move part\n Workbenches: Assembly3_Workbench\n Shortcut: **A** then **A**\n---\n\n# Assembly3 AxialMove\n\n## Description\n\nThe \"\" [Axial move](Assembly3_AxialMove.md) command provides a tool to move a part within an assembly context. It consists of 3 arcs with spherical handles to rotate the part and 3 arrow handles to move the part without rotation which represent the selected object\\'s implicit coordinate system (ICS).\n\n \"\" \n\n## Usage\n\n1. Select either a face, an edge, or a vertex of the 3D part or the whole part in the assembly tree.\n2. Activate the \"\" **Axial move** command using one of the following:\n - The ** [Axial move part](Assembly3_AxialMove.md)** button.\n - The **Assembly3 → Axial move part** menu option.\n - The keyboard shortcut: **A** then **A**.\n3. Drag the handles to reposition the part.\n4. To fix the position and leave the tool use one of the following:\n - The **Esc** key.\n - The **OK** button in the Tasks panel.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 AxialMove\n"} {"id": "freecad-docs:wiki/Assembly3_ConstraintEqualAngle.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_ConstraintEqualAngle.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_ConstraintEqualAngle.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f6fc998cbdab31dc45572a466fe0668e498fbf6dbb72ee03e1dbafbcf4917649", "bytes": 1341, "tokens": 367, "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintEqualAngle\n Icon: Assembly_ConstraintEqualAngle.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintEqualAngle\n\n## Description\n\nThis tool builds a link between two objects of an assembly and fixes one angle between them in relation to another angle\\'s value. The selected elements of each object or more precisely their implicit coordinate systems (ICS) are used to position one object to another.\n\nIt can handle 3D line elements and planar face elements as well as 2D line elements within a work plane.\n\nThe line directions as well as the face normals are represented by each ICS\\'s z-axis and so it actually fixes the angle between both elements\\' z-axes (on basis of another angle between two z-axes).\n\n## Usage\n\n1. Place two objects into an assembly\n2. Select one line element or one planar face element of each object\n3. Select two more line or one planar face elements to extract the value of the angle between them\n4. Press the ** [Equal angle](Assembly3_ConstraintEqualAngle.md)** button.\n\n: In addition the \\\"Flip element\\\" function of the elements properties panel may be needed if ICSs are not orientated as expected.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintEqualAngle\n"} {"id": "freecad-docs:wiki/Assembly3_ConstraintPointsDistance.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_ConstraintPointsDistance.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_ConstraintPointsDistance.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3f71b36e1cf5aa783317907315070e49a30baf44aa96ec25c22716f818f5ad7f", "bytes": 801, "tokens": 228, "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintPointsDistance\n Icon: Assembly_ConstraintPointsDistance.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintPointsDistance\n\n## Description\n\nThis tool builds a link between two objects of an assembly and fixes the distance between them and the orientation to each other. The selected elements of each object or more precisely their implicit coordinate systems (ICS) are used to position one object to another.\n\n## Usage\n\n1. Place two objects into an assembly\n2. Select one point element of each object\n3. Press the ** [Points distance](Assembly3_ConstraintPointsDistance.md)** button.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintPointsDistance\n"} {"id": "freecad-docs:wiki/Assembly3_MovePart.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly3_MovePart.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly3_MovePart.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4189d8b2a4fe946b5060d78e19963607116c393083bea24eae0214fce6637b89", "bytes": 1586, "tokens": 512, "text": "---\n GuiCommand:\n Name: Assembly3 MovePart\n Icon: Assembly_Move.svg\n MenuLocation: Assembly3 , Move part\n Workbenches: Assembly3_Workbench\n Shortcut: **A** then **M**\n---\n\n# Assembly3 MovePart\n\n## Description\n\nThe \"\" [Move part](Assembly3_MovePart.md) command provides a tool to move a part within an assembly context. It consists of 3 rings to rotate the part and 6 handles (crossed double arrows) to move the part without rotation. The rings and handles are positioned and oriented according to the selected object\\'s implicit coordinate system (ICS).\n\n \"\" \n\n## Usage\n\n1. Select either a face, an edge, or a vertex of the 3D part or the whole part in the assembly tree.\n2. Activate the \"\" **Move part** command using one of the following:\n - The ** [Move part](Assembly3_MovePart.md)** button.\n - The **Assembly3 → Move part** menu option.\n - The keyboard shortcut: **A** then **M**.\n3. Drag the rings and handles to reposition the part.\n4. Press **Esc** to fix the position and leave the tool.\n\n## Notes\n\nThe handles move the part parallel to one of the basic planes of the selected object\\'s ICS; pressing and holding **shift** while dragging limits the movement to one axis.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 MovePart\n"} {"id": "freecad-docs:wiki/Assembly_SolveAssembly.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Assembly_SolveAssembly.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Assembly_SolveAssembly.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f1a663cc5bbb93a206f2825c14a814ec6f06af72dcd6ec786cac0db2cda1cad9", "bytes": 900, "tokens": 300, "text": "---\n GuiCommand:\n Name: Assembly SolveAssembly\n MenuLocation: Assembly , Solve Assembly\n Workbenches: Assembly_Workbench\n Shortcut: **Z**\n Version: 1.0\n SeeAlso: \n---\n\n# Assembly SolveAssembly\n\n## Description\n\nThe \"\" [Assembly SolveAssembly](Assembly_SolveAssembly.md) tool solves the currently active Assembly.\n\n## Usage\n\n1. There are several ways to invoke the tool:\n - Press the ** [Solve Assembly](Assembly_SolveAssembly.md)** button.\n - Select the **Assembly → Solve Assembly** option from the menu.\n - Use the keyboard shortcut: **Z**.\n2. \\...\n\n\n {{Assembly_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Assembly](Assembly_Workbench.md) > Assembly SolveAssembly\n"} {"id": "freecad-docs:wiki/BIM_Box.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Box.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Box.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "8fb3cea8cc4912a6a81fa387df1f2aaab06c3794606cce4c5fbb1f8f3d7588e1", "bytes": 1267, "tokens": 391, "text": "---\n GuiCommand:\n Name: BIM Box\n MenuLocation: 3D/BIM , Generic 3D tools , Box\n Workbenches: BIM_Workbench\n SeeAlso: Part_Box\n---\n\n# BIM Box\n\n## Description\n\n\"\"\n\nThe **BIM Box** tool allows you to create a standard [Part Box](Part_Box.md), but instead of creating the object and letting you specify its dimensions and position afterwards, like the original [Part Workbench](Part_Workbench.md) tool does, this tool allows you to place and define the box dimensions graphically when creating the object. Boxes are basic [cuboid](https://en.wikipedia.org/wiki/Cuboid) shapes, that can be used as a base of any other kind of BIM object later on.\n\n## Usage\n\n1. Press the ** [Box](BIM_Box.md)** button\n2. Click a first point to define a first corner of the box. It can be any of the box corners\n3. Click a second point to define a first edge of the box, starting from the first point\n4. Click a third point to define a first face of the box, orthogonal to the first edge\n5. Click a fourth point to define the extrusion distance of the first face, forming the final box\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Box\n"} {"id": "freecad-docs:wiki/BIM_Levels.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Levels.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Levels.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "80f3839105d6d58fb0adb37877fb82eaa50beb61598b3a22c8ee89245439bb2a", "bytes": 138, "tokens": 67, "text": "# BIM Levels\n1. REDIRECT [BIM_Views](BIM_Views.md)\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Levels\n"} {"id": "freecad-docs:wiki/BIM_Material.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BIM_Material.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BIM_Material.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "8c6b8ffcc59c98f200f5b7331adbf9880ab2993e51af6634aade3fdf19f79e13", "bytes": 2499, "tokens": 719, "text": "---\n GuiCommand:\n Name: BIM Material\n MenuLocation: Manage , Material\n Workbenches: BIM_Workbench\n---\n\n# BIM Material\n\n## Description\n\nShows the **BIM material** dialog. The dialog allows to quickly and easily perform material-related operations, with extra focus on efficient working with many objects and many materials.\n\n1. Create new [material](Arch_SetMaterial.md) or [multimaterial](Arch_MultiMaterial.md)\n2. Attribute an existing material or multimaterial to selected object(s).\n\n \"\" \n\n\n*The materials manager*\n\n## Usage\n\n1. (Optionally) select one or more objects\n2. Press the ** [Material](BIM_Material.md)** button in the toolbar.\n\n- If there is no existing material in the active document, the material manager window is not displayed, and a [new material](Arch_SetMaterial.md) will be created.\n- If there is at least one material or multimaterial in the document, the Materials Manager window will open.\n\n## Material manager tools \n\nThe materials manager allows you to:\n\n- **Search materials by name**: Use the search box\n- **Assign a material to the selected object(s)**: Pressing OK with a material selected will assign it to the selected object(s)\n- **Create a [material](Arch_SetMaterial.md)**: Press the **Create new material** button\n- **Create a [multimaterial](Arch_MultiMaterial.md)**: Press the **Create new multi-material** button\n- **Delete a material**: Select a material and right-click a material and choose \\\"Delete\\\"\n- **Delete unused materials**: Press the **Delete unused** button. All materials that are not used by any object will be removed\n- **Merge duplicate materials**: Press the **Merge duplicates** button. Merges the materials with exact same names (ex. Concrete and Concrete) or exact same names with a numeric suffix (ex. Concrete and Concrete001) together\n- **Rename a material**: Right-click a material and choose \\\"Rename\\\"\n- **Duplicate a material**: Right-click a material and choose \\\"Duplicate\\\". This will create a full, independent copy of the chosen material with same settings\n- **Merge two materials together**: Right-click a material and choose \\\"Merge to\\...\\\", then select another material. The first one will be removed, and all objects that were using the first one will be assigned the second one\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](BIM_Workbench.md) > BIM Material\n"} {"id": "freecad-docs:wiki/BOLTS_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/BOLTS_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/BOLTS_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "db89aa0b21fd04ac1242e37518dd3959b867aa9e189beebf73d6070f9041110f", "bytes": 138, "tokens": 62, "text": "# BOLTS Workbench\n1. REDIRECT [BOLTSFC Workbench](BOLTSFC_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > BOLTS Workbench\n"} {"id": "freecad-docs:wiki/Branding.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Branding.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Branding.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6621ef1259e60cbbd6e172344aae62b907ef96392cf9687cd73e7eb0b9c26354", "bytes": 5033, "tokens": 1452, "text": "# Branding\n## Overview\n\nThis article describes the **Branding** of FreeCAD. Branding means to create your own application based on FreeCAD. That can be only your own executable or [splash screen](Splash_screen.md) till a complete reworked program. On base of the flexible architecture of FreeCAD it\\'s easy to use it as base for your own special purpose program.\n\n## Warning\n\nAlthough FreeCAD is offered to you free of charge, and the FreeCAD community is happy to see other applications emerging, that are based on FreeCAD, we have on the other hand seen a lot of unfair use of the information contained on this page by people who simply rebranded FreeCAD into a closed-source application to make profit from it.\n\nAlthough the [LGPL license](License.md) allows to use the FreeCAD source code in closed-source applications, it also gives strict rules to do so, and does not allow simply taking FreeCAD, renaming it and stripping it of its license.\n\nWould you be interested in using FreeCAD in a closed-source application, be sure to check thoroughly the implications of the LGPL license, and, even better, contact any FreeCAD developer, administrator or moderator before doing so.\n\n## General\n\nMost of the branding is done in the **MainCmd.cpp** or **MainGui.cpp**. These Projects generate the executable files of FreeCAD. To make your own Brand just copy the Main or MainGui projects and give the executable its own name, e.g. **FooApp.exe**. The most important settings for a new look are made in one place in the main() function. Here is the code section that controls the branding:\n\n\n C\nint main( int argc, char ** argv )\n{\n // Name and Version of the Application\n App::Application::Config()[\"ExeName\"] = \"FooApp\";\n App::Application::Config()[\"ExeVersion\"] = \"0.7\";\n\n // set the banner (for loging and console)\n App::Application::Config()[\"CopyrightInfo\"] = sBanner;\n App::Application::Config()[\"AppIcon\"] = \"FooAppIcon\";\n App::Application::Config()[\"SplashScreen\"] = \"FooAppSplasher\";\n App::Application::Config()[\"StartWorkbench\"] = \"Part design\";\n App::Application::Config()[\"HiddenDockWindow\"] = \"Property editor\";\n App::Application::Config()[\"SplashAlignment\" ] = \"Bottom|Left\";\n App::Application::Config()[\"SplashTextColor\" ] = \"#000000\"; // black\n\n // Inits the Application \n App::Application::Config()[\"RunMode\"] = \"Gui\";\n App::Application::init(argc,argv);\n\n Gui::BitmapFactory().addXPM(\"FooAppSplasher\", ( const char** ) splash_screen);\n\n Gui::Application::initApplication();\n Gui::Application::runApplication();\n App::Application::destruct();\n\n return 0;\n}\n\n\nThe first Config entry defines the program name. This is not the executable name, which can be changed by renaming or by compiler settings, but the name that is displayed in the task bar on windows or in the program list on Unix systems.\n\nThe next lines define the Config entries of your FooApp Application. A description of the Config and its entries you find in [Start up and Configuration](Start_up_and_Configuration.md).\n\n## Images\n\nImage resources are compiled into FreeCAD using [Qt\\'s resource system](http://qt-project.org/doc/qt-4.8/resources.html). Therefore you have to write a **.qrc** file, an XML-based file format that lists image files on the disk but also any other kind of resource files. To load the compiled resources inside the application you have to add a line\n\n \n```python\nQ_INIT_RESOURCE(FooApp); \n```\n\ninto the main() function. Alternatively, if you have an image in XPM format you can directly include it into your **main.cpp** and add the following line to register it:\n\n \n```python\nGui::BitmapFactory().addXPM(\"FooAppSplasher\", ( const char** ) splash_screen);\n```\n\n## Branding XML \n\nIn FreeCAD there is also a method supported without writing a customized main() function. For this method you must write a file name called **branding.xml** and put it into the installation directory of FreeCAD. Here is an example with all supported tags:\n\n\n XML\n\n\n FooApp\n Foo App in title bar\n 1\n 0\n 1234\n 2014/1/1\n (c) My copyright\n Foo App URL\n Path to logo (appears in bottom right corner)\n Path to icon file\n Path to program icons\n splashscreen.png\n Bottom|Left\n #ffffff\n #c8c8c8\n PartDesignWorkbench\n\n\n\nAll listed tags are optional.\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Branding\n"} {"id": "freecad-docs:wiki/CAM_DressupDragKnife.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_DressupDragKnife.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_DressupDragKnife.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0ff7b785b7fbd6fb01f44c9dfe4db170a61d6d14902df0ab81c24280b987a611", "bytes": 1696, "tokens": 544, "text": "---\n GuiCommand:\n Name: CAM DressupDragKnife\n MenuLocation: CAM , Path Dressup , DragKnife\n Workbenches: CAM_Workbench\n SeeAlso: CAM_DressupTag, CAM_DressupRampEntry, CAM_DressupDogbone\n---\n\n# CAM DressupDragKnife\n\n## Description\n\nThe tool \"\" [DressupDragKnife](CAM_DressupDragKnife.md) uses a cutting edge on a pivot to cut sheet material like vinyl, cardboard, and leather. The cutting point is not aligned with the center of the spindle but rather follows it as the spindle moves. Because the cutting point is offset, the path must be modified to extend past the endpoint of each segment. Also, the dragknife is incapable of making extremely tight turns. To compensate, a pivot \\'corner action\\' is inserted which momentarily lifts the blade slightly and then pivots into the new position.\n\nThis tool dresses up an existing path to add corner actions and edge extensions for drag knife cutting.\n\n## Usage\n\n1. Select a contour or profile path object.\n2. Select the **CAM → Path Dressup → DragKnife** option from the menu.\n\n## Options\n\n- **Filter Angle** : Determines how acute an angle must be before a corner action is inserted.\n- **Offset** : Input how much the blade point is offset from the spindle center.\n- **Pivot Height** : Determines how high to lift the cutting blade during a corner action. This is material dependent and should be higher for thicker materials. Ideally, the point should remain in the material slightly.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM DressupDragKnife\n"} {"id": "freecad-docs:wiki/CAM_SimpleCopy.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_SimpleCopy.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_SimpleCopy.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7caad06262773c3d68cb5953758a47cec0bf06e5a9840d7da92de5cc292378b7", "bytes": 853, "tokens": 316, "text": "---\n GuiCommand:\n Name: CAM SimpleCopy\n MenuLocation: CAM , Path Modification , Simple Copy\n Workbenches: CAM_Workbench\n SeeAlso: CAM_Copy\n---\n\n# CAM SimpleCopy\n\n## Description\n\nThe tool \"\" [SimpleCopy](CAM_SimpleCopy.md) creates a non-parametric copy of a given path.\n\n## Usage\n\n1. Select one [CAM](CAM_Workbench.md) object\n2. Press the ** [Simple Copy](CAM_SimpleCopy.md)** button\n\n## Options\n\n- The simple copy is not bound anymore to the path that was used to make the copy, and is not parametric. Therefore, when edited with the [CAM Inspect](CAM_Inspect.md) tool, any change made to its G-code will be retained.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM SimpleCopy\n"} {"id": "freecad-docs:wiki/CAM_Surface.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_Surface.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_Surface.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a66cd99b33066d5667b32f177cb86b9413c49d66b0b657817823a691a3ea809e", "bytes": 19119, "tokens": 5337, "text": "---\n GuiCommand:\n Name: CAM Surface\n MenuLocation: CAM , 3D Surface\n Workbenches: CAM_Workbench\n Version: 0.19\n---\n\n# CAM Surface\n\n## Description\n\nThis tool creates a new \"\" [3D Surface](CAM_Surface.md) operation which is capable of generating G-code paths for the entire top surface of a 3D model (or is able to work with selected faces) and allows for faces to be avoided. This operation offers multiple cut patterns: Line, Zigzag, Circular, Circular Zigzag, Offset, and Spiral (similar to an adaptive pattern). As of version 0.19, this operation offers many customizations to allow for greater productivity.\n\nThe \"\" [3D Surface](CAM_Surface.md) operation is also capable of generating basic rotational 3D surfacing paths. The rotational capabilities are limited to the entire model, and do not allow for specific faces or regions to be isolated. The rotational paths are also limited to line cut patterns.\n\nThe 3D Surface Tool interfaces to OCL.pyd, a 3rd party Open Source module titled [OpenCamLib](OpenCamLib.md), that generates tool paths from a 3D model. OpenCamLib is not integrated directly into FreeCAD.\n\n**Note:** In order to use the 3D Surface operation you must:\n\n1. Properly install [OpenCamLib](OpenCamLib.md).\n2. Enable [Experimental Features](CAM_experimental.md) for the CAM Workbench.\n3. Check **Edit → Preferences... → CAM → Advanced → Enable OCL dependent features**.\n\n## Usage\n\nUsage instructions for multiple variations of the [3D Surface](CAM_Surface.md) operation are presented here.\n\n#### Basic Operation \n\n1. Press the ** [3D Surface](CAM_Surface.md)** icon, or select **CAM → 3D Surface** from the dropdown menu.\n2. Select the tool controller for the Operation from the Tool controller dialogue pop up window, if presented.\n3. In the Base Geometry tab, select any specific faces you wish to focus on and/or avoid for the operation.\n4. Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.\n5. Make adjustments in Heights tab if needed.\n6. Configure settings in the Operations tab as needed:\n - Choose your Coolant Mode.\n - Choose the BoundBox: Stock or BaseBoundBox\n - Set the Scan Type for the operation: Planar or Rotational\n - Select the Layer Mode for the operation: Single-pass or Multi-pass\n 1. Single-pass is for a finishing pass\n 2. Multi-pass could be used for clearing in combination with the use of Depth Offset to leave a thin surface layer for a finish pass\n - Add additional BoundBox Extra Offset to X and Y as desired (*Rotational scans only*)\n - Set the Drop Cutter Direction: X or Y. This is the linear direction the cutter(spindle) will travel. (*Rotational scans only*)\n - Add a Depth Offset value if you wish to leave a specified thickness of material on the surface, for say a final finish pass\n - Set the Sample Interval used for the OCL scan.\n - Set the Step Over value as a percentage of the diameter of the Tool.\n - Check the Use Start Point box if you wish to provide a start point for the operation in the properties view of the data tab for the operation.\n - Boundary Enforcement is enabled by default. This forces the cutter to remain inside the boundaries of the feature geometry for the operation, like a pocketing operation. Disable to allow the cutter to extend to the outside of the feature geometry. The Boundary Adjustment property supersedes this property.\n - Optimize Linear Paths is enabled by default. Disabling will yield a longer gcode result and likely increase cut time.\n7. If you wish to preview the result before accepting the settings, click **Apply**\n8. Click **OK** button to confirm and generate paths.\n\nTo achieve different, or more complex, effects, adjust additional operation properties within the Data tab of the Properties View for the operation.\n\n#### Rotational Scans (4th-axis) \n\n1. Initiate a [Basic Operation](#Basic_Operation.md) as described above and set the **Scan Type** to **Rotational**.\n2. **Note:** Face selection is unavailable for Rotational scans, so changes to Base Geometry are ignored.\n3. Locate the Data tab and Properties View for the new [3D Surface](CAM_Surface.md) operation. A **Rotation** section should be available with additional properties to adjust, listed below.\n It is recommended that you set the desired rotation properties all at once before recomputing. This is done by clicking the ENTER key immediately after changing a property setting. This process will allow you to change and save multiple properties before recomputing the operation.\n4. Adjust the following settings as needed:\n - Set **Cutter Tilt** to the offset index(angle) \\[0-90\\]. (Used for ball mill cutters)\n - Change **Drop Cutter Dir** to the axis of travel for the cutter(spindle).\n - Change **Drop Cutter Extra Offset** to extend the BoundBox in the X and Y directions.\n - Set **Rotation Axis** to the desired axis.\n - Adjust **Start Index** to start index(angle) \\[0-360\\].\n - Adjust **Stop Index** to stop index(angle) \\[0-360\\].\n5. Click the **[ [Refresh](Std_Refresh.md)** icon in the tool bar.\n6. Wait for the results\\...\n\n##### Notes About Rotational Scans \n\n- **Rotational** scans require much more time and processing than **Planar** scans. Factors affecting processing time include: Sample Interval, Step Over, tool diameter, and model size. Again, rotational scans can take a long time. Some might take 3, 5 or 10 minutes or longer.\n- For time purposes, it is better that you not recompute a rotational scan after every property change; rather, consider one of the following:\n - use the \\' *change all settings with ENTER key* \\' technique mentioned in Step 2 above, then **[ [Refresh](Std_Refresh.md)** the operation.\n - deactivate the operation with the ** [Active](CAM_OpActiveToggle.md)** toggle tool, make your changes to the operation\\'s properties, then click the ** [Active](CAM_OpActiveToggle.md)** icon again to re-activate the operation - which triggers a recompute internally.\n- The ** [3D Surface](CAM_Surface.md)** operation is still considered an *experimental feature* as of 2019-06-25. As such, it may contain a few bugs yet to be clearly identified. Please report bugs and issues in the [FreeCAD Path/CAM Forum](https://forum.freecadweb.org/viewforum.php?f=15).\n- The built in ** [CAM Simulator](CAM_Simulator.md)** does NOT support 4th-axis simulation. You will need to use a third party simulator to inspect or verify paths visually. See the [Resources](#Resources.md) section below for suggestions.\n- You will likely see red rotational lines around your model in the viewport. This is normal in FreeCAD for the time being.\n\n##### Notes About Scans of complex models \n\nExcessively long processing times (longer than 10 minutes) can occur when processing large complex models. In addition to the factors already mentioned the following steps could help identify potential causes and solutions.\n\n***Low Memory***\nCheck how much memory is available while the scan is running using a tool such as the Windows **Task Manager, Memory tab**. If more than 90% of memory is consistently being used then a small **Linear Deflection** parameter could be generating a mesh that is too large for the available memory.\nTo confirm this \\...\n\n1. Create a new ** [3D Surface](CAM_Surface.md)** operation.\n2. Switch to the Model tab and increase the **Linear Deflection** value. For example change from 2.5um to 20um\n3. Switch back to the Tasks tab to complete setting up the operation.\n4. Click **OK** button to confirm and generate paths.\n\nTo make this value the default for all new ** [3D Surface](CAM_Surface.md)** operations, change the **GeometryTolerance** parameter.\n**Tools → Edit Parameters ... → Preferences → Mod → CAM → GeometryTolerance **.\nNote as of version 0.19 the **Linear Deflection** default = GeometryTolerance / 4\n\n***Invalid Geometry***\nIf a model contains invalid geometry the scanning time can increase significantly. A model can be checked using the [Part CheckGeometry](Part_CheckGeometry.md) function in \"\"**Part Workbench**.\nTo run the tool:\n\n1. Switch to the \"\"**Part Workbench** and select the model to check\n2. Click on the ** [Part CheckGeometry](Part_CheckGeometry.md)** button available in the Part workbench toolbar OR use the **Part → Check geometry** entry from the top menu.\n3. Click the **Run Check** button and review the results.\n\nIf the results includes items like *BOPAlgo SelfIntersect* then the geometry is invalid and should be corrected by adjusting the model.\n(Hint: Boolean operations and Loft commands can sometimes introduce *Self Intersections*)\n\n#### Available Tool (Cutter) Shapes \n\nThis 3D Surface op currently uses [OpenCamLib](OpenCamLib.md) to extract paths from the part base. As such, a tool setting translation is required between the FreeCAD tool controller and OCL in order to complete the scan with your chosen tool(cutter) shape.\n\nThese tool shapes are respected and available for this 3D Surface operation:\n\n- End mill\n- Ball end mill\n- Bull nose end mill\n- Chamfer bit\n- Engraver\n\nShould you choose to run the path simulator in the CAM Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.\n\nNOTE: As of May 2019, only the End Mill has any type of testing to determine accuracy of the FreeCAD-to-OCL tool settings translation. Please post any feedback for non-end-mill usage to the [Path/CAM](https://forum.freecadweb.org/viewforum.php?f=15) section in the FreeCAD forums.\n\n## Properties: Version 0.19 \n\n***Note***: Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.\n\n\n{{TitleProperty|Base}}\n\nNote: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the CAM Job model as needed.\n\n- **Placement**: Overall placement \\[position and rotation\\] of the object - with respect to the origin (or origin of parent object container)\n\n - \n **Angle**\n \n : Angle in degrees applied to rotation of the object around Axis property value\n\n - \n **Axis**\n \n : Axis (one or multiple) around which to rotate the object, set in sub-properties: X, Y, Z\n\n - \n **X**\n \n : X axis value\n\n - \n **Y**\n \n : Y axis value\n\n - \n **Z**\n \n : Z axis value\n\n - \n **Position**\n \n : Position of the object, set in sub-properties: X, Y, Z - with respect to the origin (or origin of parent object container)\n\n - \n **X**\n \n : X distance value\n\n - \n **Y**\n \n : Y distance value\n\n - \n **Z**\n \n : Z distance value\n\n- **Label**: User-provided name of the object (UTF-8)\n\n\n{{TitleProperty|Clearing Options}}\n\n- **Bound Box**: Should the operation be limited by the stock object or by the bounding box of the base object\n\n- **Cut Mode**: The direction that the toolpath should go around the part: Climb(ClockWise) or Conventional(CounterClockWise)\n\n- **Cut Pattern**: Clearing pattern to use\n\n- **Cut Pattern Reversed**: Reverse the cut order of the stepover paths. For circular cut patterns, begin at the outside and work toward the center\n\n- **Depth Offset**: Z-axis offset from the surface of the object\n\n- **Layer Mode**: The completion mode for the operation: single or multi-pass\n\n- **Pattern Center At**: Choose location of the center point for starting the cut pattern\n\n- **Pattern Center Custom**: Set the start point for the cut pattern\n\n- **Profile Edges**: Profile the edges of the selection. There are the following options (images can be seen in this forum post: ):\n\n - \n **None**\n \n : Don\\'t create a profile\n\n - \n **Only**\n \n : Create only a profile and no inner paths\n\n - \n **First**\n \n : Start with the profile and then do the rest\n\n - \n **Last**\n \n : Start with the rest and then do the profile\n\n- **Sample Interval**: The Sample Interval. Small values cause long wait times\n\n- **Step Over**: Step over percentage of the drop cutter path\n\n\n{{TitleProperty|Depth}}\n\n- **Clearance Height**: The height needed to clear clamps and obstructions\n\n- **Final Depth**: Final Depth of Tool- lowest value in Z\n\n- **Safe Height**: The above which Rapid motions are allowed.\n\n- **Start Depth**: Starting Depth of Tool- first cut depth in Z\n\n- **Step Down**: Incremental Step Down of Tool\n\n\n{{TitleProperty|Mesh Conversion}}\n\n- **Angular Deflection**: Smaller values yield a finer, more accurate mesh. Smaller values increase processing time a lot\n\n- **Linear Deflection**: Smaller values yield a finer, more accurate mesh. Smaller values do not increase processing time much but can increase memory comsumption\n\n\n{{TitleProperty|Optimization}}\n\n- **Circular Use G2 G3**: Convert co-planar arcs to G2/G3 gcode commands for \\Circular\\ and \\CircularZigZag\\ cut patterns\n\n- **Gap Sizes**: Feedback: three smallest gaps identified in the path geometry\n\n- **Gap Threshold**: Collinear and co-radial artifact gaps that are smaller than this threshold are closed in the path\n\n- **Optimize Linear Paths**: Enable optimization of linear paths (co-linear points). Removes unnecessary co-linear points from G-Code output\n\n- **Optimize Step Over Transitions**: Enable separate optimization of transitions between, and breaks within, each step over path\n\n\n{{TitleProperty|Path}}\n\n- **Active**: Make False, to prevent operation from generating code\n\n- **Base**: The base geometry for this operation\n\n- **Comment**: An optional comment for this Operation\n\n- **Coolant Mode**: Coolant mode for this operation\n\n- **Cycle Time**: Operations Cycle Time Estimation\n\n- **Tool Controller**: Defines the Tool controller used in the Operation\n\n- **User Label**: User assigned label\n\n\n{{TitleProperty|Rotation}}\n\n- **Cutter Tilt**: Set the cutter (spindle) tilt angle.\n\n- **Drop Cutter Dir**: The direction along which dropcutter lines are created\n\n- **Drop Cutter Extra Offset**: Additional offset to the selected bounding box - use sub-properties to set values\n\n - \n **X**\n \n : X distance value\n\n - \n **Y**\n \n : Y distance value\n\n - \n **Z**\n \n : Z distance value\n\n- **Rotation Axis**: Set the axis for model rotation.\n\n- **Start Index**: Start index(angle) for rotation\n\n- **Stop Index**: Stop index(angle) for rotation\n\n\n{{TitleProperty|Selected Geometry Settings}}\n\n- **Avoid Last X Faces**: Avoid cutting the last \\'N\\' faces in the Base Geometry list of selected faces\n\n- **Avoid Last X Internal Features**: Do not cut internal features on avoided faces\n\n- **Boundary Adjustment**: Positive values push the cutter toward, or beyond, the boundary. Negative values retract the cutter away from the boundary\n\n- **Boundary Enforcement**: If true, the cutter will remain inside the boundaries of the model or selected face(s)\n\n- **Handle Multiple Features**: Choose how to process multiple Base Geometry features\n\n- **Internal Features Adjustment**: Positive values push the cutter toward, or into, the feature. Negative values retract the cutter away from the feature\n\n- **Internal Features Cut**: Cut internal feature areas within a larger selected face\n\n\n{{TitleProperty|Start Point}}\n\n- **Start Point**: The custom start point for the path of this operation, set in sub-properties: X, Y, Z\n\n - \n **X**\n \n : X axis value\n\n - \n **Y**\n \n : Y axis value\n\n - \n **Z**\n \n : Z axis value\n\n- **Use Start Point**: Make True, if specifying a Start Point\n\n\n{{TitleProperty|Surface}}\n\n- **Scan Type**: Planar: Flat, 3D surface scan. Rotational: 4th-axis rotational scan.\n\n\n{{TitleProperty|Waste}}\n\n- **Ignore Waste**: Ignore areas that proceed below specified depth.\n\n- **Ignore Waste Depth**: Depth used to identify waste areas to ignore.\n\n- **Release From Waste**: Cut through waste to depth at model edge, releasing the model.\n\n## Tasks Window Editor Layout \n\n*Descriptions for the settings are provided in the Properties list above.*\n\nThis section is simply a layout map of the settings in the window editor for the Operation.\n\n### Base Location \n\n- **Base Geometry import selection**: Use this list to select Base Geometry to be imported from the selected, existing operation\n- **Import**: Imports the selected operation\\'s Base Geometry into the current operations Base Geometry list\n- **Base Geometry list for current operation**: List of Base Geometry for current operation, if any selected\n- **Add**: Adds selected element(s) which should be the base(s) for the path(s)\n- **Remove**: Remove the selected item(s) in the Base Location list\n- **Clear**: Clear all items in the Base Location list\n\n### Depth\n\n- **Start Depth**\n \n\n- **Final Depth**\n \n\n- **Step Down**\n \n\n### Height\n\n- **Safe Height**\n \n\n- **Clearance Height**\n \n\n### Operation\n\n- **Tool Controller**\n \n\n- **Coolant Mode**\n \n\n- **BoundBox**\n \n\n- **Scan Type**\n \n\n- **Layer Mode**\n \n\n- **BoundBox extra offset X**\n \n\n- **BoundBox extra offset Y**\n \n\n- **Drop Cutter Direction**\n \n\n- **Depth Offset**\n \n\n- **Step Over**\n \n\n- **Sample Interval**\n \n\n- **Optimize Output Enabled**\n \n\n- **Use Start Point**\n \n\n- **Boundary Enforcement**\n \n\n- **Optimize Linear Paths**\n \n\n## Resources\n\n- G-code(path) simulator: [NCViewer](https://ncviewer.com/)\n- G-code(path) simulator: [CAMotics](https://www.camotics.org/)\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Surface\n"} {"id": "freecad-docs:wiki/CAM_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "53c69deb687c8132fc346e425367bc1d83846b61ee0c1fd2468c61e075da6ee9", "bytes": 16330, "tokens": 5633, "text": "# \"CAM CAM Workbench\n\n \n\n## Introduction\n\nThe \"\" [CAM Workbench](CAM_Workbench.md) is used to produce machine instructions for [CNC machines](https://en.wikipedia.org/wiki/CNC_router) from a FreeCAD 3D model. These produce real-world 3D objects on CNC machines such as mills, lathes, lasercutters, or similar. Typically, instructions are a [G-code](https://en.wikipedia.org/wiki/G-code) dialect. A [general CNC lathe tool path sequence simulation example](https://www.ange-softs.com/SIMULCNCHTML/index.html) is presented here.\n\n \"\" \n\nThe FreeCAD CAM Workbench workflow creates these machine instructions as follows:\n\n- A 3D model is the base object, typically created using one or more of the \"\" [Part Design](PartDesign_Workbench.md), \"\" [Part](Part_Workbench.md) or \"\" [Draft](Draft_Workbench.md) Workbenches.\n- A [CAM Job](CAM_Job.md) is created in the CAM Workbench. This contains all the information required to generate the necessary G-code to process the Job on a CNC mill: there is Stock material, the mill has a certain [set of tools](CAM_ToolBitLibraryOpen.md) and it follows certain commands controlling speed and movements (usually G-code).\n- [CAM Tools](CAM_Tools.md) are selected as required by the Job Operations.\n- Milling paths are created using e.g. [Contour](CAM_Profile.md) and [Pocket](CAM_Pocket_3D.md) Operations. These CAM objects use internal FreeCAD G-code dialect, independent of the CNC machine.\n- Export the job with a G-code, matching to your machine. This step is called *post processing*; there are different post processors available.\n\n## General concepts \n\nThe CAM Workbench generates G-code defining the paths required to mill the Project represented by the 3D model on the target mill in [the CAM Job Operations FreeCAD G-code dialect](CAM_scripting#The_FreeCAD_Internal_GCode_Format.md), which is later translated to the appropriate dialect for the target CNC controller by selecting the appropriate postprocessor.\n\nThe G-code is generated from directives and Operations contained in a CAM Job. The Job Workflow lists these in the order they will be executed. The list is populated by adding CAM Operations, Path Dressups, Supplemental Commands, and Path Modifications from the CAM Menu, or GUI buttons.\n\nThe CAM Workbench provides a Tool Manager (Library, Tool-Table), and G-code Inspection, and Simulation tools. It links the Postprocessor, and allows importing and exporting Job Templates.\n\nThe CAM Workbench has external dependencies including:\n\n1. The FreeCAD 3D model units are defined in the **Edit → Preference → General → Default unit system**. The Postprocessor configuration defines the final G-code units.\n2. The Macro file path, and Geometric tolerances, are defined in the **Edit → Preferences → CAM → Job Preferences** tab.\n3. Colors are defined in the **Edit → Preferences → CAM → GUI** tab.\n4. Holding tag parameters are defined in the **Edit → Preferences → CAM → Dressups** tab.\n5. That the Base 3D model quality supports the CAM workbench requirements, passes Check Geometry.\n\n## Limitations\n\nSome current limitations of which you should be aware are:\n\n- Most of the CAM Tools are not true 3D tools but only 2.5D capable. This means that they take a fixed 2D shape and can cut it down to a given depth. However, there are two tools which produce true 3D paths: ** [3D Pocket](CAM_Pocket_3D.md)** and ** [3D Surface](CAM_Surface.md)** (which is still an [experimental feature](CAM_experimental.md) as of November 2020).\n- Most of CAM workbench is designed for a simple, standard 3-axis (xyz) CNC mill/router, but lathe tools are under development in 0.19_pre.\n- Most operations in CAM workbench will return paths based on a standard endmill tool/bit only, regardless of the tool/bit type assigned in a given tool controller with the exception of the ** [Engrave](CAM_Engrave.md)** and ** [3D Surface](CAM_Surface.md)** operations.\n- The operations within the CAM workbench are not aware of clamping mechanisms in use to secure the model to your machine. Consequently, please review and simulate the paths you generate prior to sending the code to your machine. If necessary, model your clamping mechanisms in FreeCAD in order to better inspect the paths generated. Look for possible collisions with clamps or other obstacles along the paths.\n\n## Units\n\nUnit handling in CAM can be confusing. There are several points to understand:\n\n1. FreeCAD base units for length and time are \\'mm\\' and \\'s\\' respectively. Velocity is thus \\'mm/s\\'. This is what FreeCAD stores internally regardless of anything else\n2. The default unit schema uses the default units. If you\\'re using the default schema and you enter a feed rate without a unit string, it will get entered as \\'mm/s\\'\n3. Most CNC machines expect feed rate in the form of either \\'mm/min\\' or \\'in/min\\'. Most post-processors will automatically convert the unit when generating gcode.\n\nSchemas:\n\n1. Changing schema in preferences changes default unit string for the input fields. If you\\'re a CAM user and prefer to design in metric, it\\'s highly recommended that you use the \\\"Metric Small Parts & CNC\\\" schema. If you design in US units, either the Imperial Decimal and Building US will work.\n2. Changing your preferred unit schema will have no effect on output but will help avoid input errors.\n\nOutput:\n\n1. Generating the correct unit in output is the responsibility of the post-processor and is done only at that time.\n2. Machine output unit is completely unrelated to your selected unit schema.\n3. Post-processors produce either metric (G21) output, Imperial (G20) output or are configurable.\n4. Configurable post-processors default to metric (G21).\n5. If you want your configurable post-processor to output imperial G-code (G20), set the correct argument in your job output configuration (ie \\--inches for linuxcnc). This can be stored in a job template and set as your default template to make it automatic for all future jobs.\n\nCAM Inspection:\n\n1. If you use the CAM Inspect tool to look at G-code, you will see it in \\'mm/s\\' because it is not being post-processed.\n\n## Heights and depths \n\nMany of the commands have various heights and depths:\n\n\"\" \n*Visual reference for Depth properties (settings)*\n\n## Commands\n\nSome commands are experimental and not available by default. To enable them see [CAM experimental](CAM_experimental.md).\n\n### Project Commands \n\n- \"\" [Job](CAM_Job.md): Creates a new CNC job.\n\n- \"\" [Post Process](CAM_Post.md): Exports a project to G-code.\n\n- \"\" [Check the CAM job for common errors](CAM_Sanity.md): Checks the selected job for missing values.\n\n- \"\" [Export Template](CAM_ExportTemplate.md): Export the current job as a template.\n\n### Tool Commands \n\n- \"\" [Inspect CAM Commands](CAM_Inspect.md): Shows the G-code for checking.\n\n- \"\" [CAM Simulator](CAM_Simulator.md): Shows the milling operation like it\\'s done on the machine.\n\n- \"\" [CAM SimulatorGL](CAM_SimulatorGL.md): Enables the new, improved CAM simulator. (v1.0) \n\n- \"\" [Finish Selecting Loop](CAM_SelectLoop.md): Completes a loop from two selected edges.\n\n- \"\" [Toggle the Active State of the Operation](CAM_OpActiveToggle.md): Activates or de-activates a path operation.\n\n- \"\" [ToolBit Library editor](CAM_ToolBitLibraryOpen.md): Opens an editor to manage ToolBit libraries.\n\n- \"\" [ToolBit Dock](CAM_ToolBitDock.md): Toggles the ToolBit Dock.\n\n### Basic Operations \n\n- \"\" [Profile](CAM_Profile.md): Creates a profile operation of the entire model, or from one or more selected faces or edges.\n\n- \"\" [Pocket Shape](CAM_Pocket_Shape.md): Creates a pocketing operation from one or more selected pocket(s).\n\n- \"\" [Drilling](CAM_Drilling.md): Performs a drilling cycle.\n\n- \"\" [Face](CAM_MillFace.md): Creates a surfacing path.\n\n- \"\" [Helix](CAM_Helix.md): Creates a helical path.\n\n- \"\" [Adaptive](CAM_Adaptive.md): Creates an adaptive clearing and profiling operation.\n\n- \"\" [Slot](CAM_Slot.md): Creates a slotting operation from selected features or custom points. [**Experimental**](CAM_experimental.md).\n\n- \"\" [Engrave](CAM_Engrave.md): Creates an engraving path.\n\n- \"\" [Deburr](CAM_Deburr.md): Creates a deburr path.\n\n- \"\" [Vcarve](CAM_Vcarve.md): Creates an engraving path using a V tool shape.\n\n### 3D Operations \n\n- \"\" [3D Pocket](CAM_Pocket_3D.md): Creates a path for a 3D pocket.\n\n- \"\" [3D Surface](CAM_Surface.md): Creates a path for a 3D surface. [**Experimental**](CAM_experimental.md).\n\n- \"\" [Waterline](CAM_Waterline.md): Creates a waterline path for a 3D surface. [**Experimental**](CAM_experimental.md).\n\n### Path Dressup \n\n- \"\" [Axis Map](CAM_DressupAxisMap.md): Remaps one axis to another.\n\n- \"\" [Boundary](CAM_DressupPathBoundary.md): Adds a boundary dressup modification to a selected path.\n\n- \"\" [Dogbone](CAM_DressupDogbone.md): Adds a dogbone dressup modification to a selected path.\n\n- \"\" [DragKnife](CAM_DressupDragKnife.md): Adds a dragknife dressup modification to a selected path.\n\n- \"\" [LeadInOut](CAM_DressupLeadInOut.md): Adds a lead-in and/or lead-out point to a selected path.\n\n- \"\" [RampEntry](CAM_DressupRampEntry.md): Adds ramp entry dressup modification to a selected path.\n\n- \"\" [Tag](CAM_DressupTag.md): Adds a holding tag dressup modification to a selected path.\n\n- \"\" [Z Depth Correction](CAM_DressupZCorrect.md): Corrects the Z depth using Probe Map.\n\n### Supplemental Commands \n\n- \"\" [Fixture](CAM_Fixture.md): Changes the fixture position.\n\n- \"\" [Comment](CAM_Comment.md): Inserts a comment in the G-code of a path.\n\n- \"\" [Stop](CAM_Stop.md): Inserts a full stop of the machine.\n\n- \"\" [Custom](CAM_Custom.md): Inserts custom G-code.\n\n- \"\" [Probe](CAM_Probe.md): Creates a Probing Grid from a job stock.\n\n- \"\" [From Shape](CAM_Shape.md): Creates a path object from a selected Part object. [**Experimental**](CAM_experimental.md).\n\n### Path Modification \n\n- \"\" [Copy the operation in the job](CAM_Copy.md): Creates a parametric Copy of a selected path object.\n\n- \"\" [Array](CAM_Array.md): Creates an array by duplicating a selected path.\n\n- \"\" [Simple Copy](CAM_SimpleCopy.md): Creates a non-parametric copy of a selected path object.\n\n### Specialty Operations \n\n- \"\" [Thread Milling](CAM_ThreadMilling.md): Creates a CAM Thread Milling operation from features of a base object. [**Experimental**](CAM_experimental.md).\n\n### Miscellaneous\n\n- \"\" [Area](CAM_Area.md): Creates a feature area from selected objects. [**Experimental**](CAM_experimental.md).\n\n- \"\" [Area workplane](CAM_Area_Workplane.md): Creates a feature area workplane. [**Experimental**](CAM_experimental.md).\n\n## ToolBit architecture \n\nManage tools, bits, and the Tool Library. Based on the ToolBit architecture.\n\n- [CAM Tools](CAM_Tools.md)\n- [CAM ToolShape](CAM_ToolShape.md)\n- [CAM ToolBit](CAM_ToolBit.md)\n- [CAM ToolBit Library](CAM_ToolBit_Library.md)\n- [CAM ToolController](CAM_ToolController.md)\n\n## Other\n\n- [CAM FAQ](CAM_FAQ.md): The CAM Workbench shares many concepts with other CAM software packages but has its own peculiarities. If something seems wrong this is a good place to start.\n- [CAM SetupSheet](CAM_SetupSheet.md): You can use a SetupSheet to customize how various property values for operations are calculated.\n- [CAM Postprocessor Customization](CAM_Postprocessor_Customization.md): If you have a special machine which cannot use one of the available post-processors you may need to write your own post-processor.\n- [CAM fourth axis](CAM_fourth_axis.md): Experimental four axis milling.\n\n## Preferences\n\n- \"\" [Preferences\\...](CAM_Preferences.md): Preferences available for the CAM Workbench.\n\n## Scripting\n\nSee [CAM scripting](CAM_scripting.md).\n\n## Tutorials\n\n- [CAM Walkthrough for the Impatient](CAM_Walkthrough_for_the_Impatient.md): a quick tutorial to get familiar with CAM.\n\n## Videos\n\n- [FreeCAD Path: Custom paths with Python - Part 1 - 5](https://www.youtube.com/playlist?list=PLEuOia-QxyFKgzAeTyH62GKqWKVURiWJL): A playlist with a series of 5 videos in English by sliptonic. This series shows how to work with the [CAM Workbench](CAM_Workbench.md).\n- [FreeCAD CAM Path Workbench](https://www.youtube.com/playlist?list=PLUrr_kHPp4vhGdLlj6IemtF-OPUlRvSTC): A playlist with a series of 7 videos in English by CAD CAM Lessons.\n- [FreeCAD CAM CNC](https://www.youtube.com/playlist?list=PLUrr_kHPp4vh2n6DcIlegK4dEKIFjmISJ): A playlist with a series of 8 videos in English by CAD CAM Lessons.\n- Also see the [Computer-Aided Manufacturing (CAM) section](Video_tutorials#Computer-Aided_Manufacturing_(CAM).md) of the [Video tutorials](Video_tutorials.md) wiki page.\n\n## Roadmap\n\n- [CAM Development Roadmap](CAM_Development_Roadmap.md): Read this if you are a developer and want to contribute to CAM.\n\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [CAM](Category_CAM.md) > CAM Workbench\n"} {"id": "freecad-docs:wiki/CAM_experimental.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/CAM_experimental.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/CAM_experimental.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "8741735143d1b555a4c1450eff2eb3a8ef84d2c5f4c6b6369026b92cc405cd4f", "bytes": 1820, "tokens": 541, "text": "# CAM experimental\n## Description\n\nThe CAM Workbench contains a set of hidden commands. They are hidden by default because they are experimental. A command can be considered experimental for any of the following reasons:\n\n- It is incomplete.\n- It is bug-ridden.\n- It is unstable.\n- It does not produce correct, stable, safe, paths.\n- It is not a standard, regularly used command in the traditional CAM workflow.\n- It is mature but has not yet been moved to the standard tool list.\n- \\... other reasons.\n\n## Enable experimental commands \n\nTo access the hidden experimental commands of the CAM Workbench, the user must enable them in the [Parameter Editor](Std_DlgParameter.md).\n\n1. Open the [Parameter Editor](Std_DlgParameter.md) via **Tools → Edit Parameters...**\n2. Once in the editor the path is **BaseApp → Preferences → Mod → CAM**\n3. To enable the [CAM Area](CAM_Area.md) and [CAM Area Workplane](CAM_Area_Workplane.md) commands:\n - Right-click in the parameter list area and select **New → New Boolean item** from the context menu.\n - Name the new parameter: `EnableAdvancedOCLFeatures` (case-sensitive).\n - Set it to: `True`.\n4. To enable the other experimental commands:\n - Again select **New → New Boolean item** from the context menu.\n - Name the new parameter: `EnableExperimentalFeatures` (case-sensitive).\n - Set it to: `True`.\n5. Save the settings.\n6. Restart FreeCAD.\n\n## Additional Information \n\nRead more about the specific experimental commands on the [wiki pages that link to this one](https://www.freecadweb.org/wiki/Special:WhatLinksHere/CAM_experimental).\n\n {{CAM_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Poweruser_Documentation](Category_Poweruser_Documentation.md) > [CAM](CAM_Workbench.md) > CAM experimental\n"} {"id": "freecad-docs:wiki/Category_Administration.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Administration.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Administration.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "590d7900744be5fe70dbcde85403d6690f108e37999b52b80ec4b64fbefcfb48", "bytes": 4925, "tokens": 1985, "text": "# Category:Administration\nThis category contains articles and categories about wiki administrative subjects.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:Arch Tools navi](Template_Arch_Tools_navi.md) | [Template:ASCII](Template_ASCII.md) | [Template:Assembly Tools navi](Template_Assembly_Tools_navi.md) |\n| [Backend Adminstration](Backend_Adminstration.md) | [Template:BIM Tools navi](Template_BIM_Tools_navi.md) | [Template:CAM Tools navi](Template_CAM_Tools_navi.md) |\n| [Template:CfdOF Tools navi](Template_CfdOF_Tools_navi.md) | [Changelog](Changelog.md) | [Template:Choice](Template_Choice.md) |\n| [Template:Code](Template_Code.md) | [Template:ColoredParagraph](Template_ColoredParagraph.md) | [Template:ColoredText](Template_ColoredText.md) |\n| [Crowdin Administration](Crowdin_Administration.md) | [Crowdin Scripts](Crowdin_Scripts.md) | [Template:Delete](Template_Delete.md) |\n| [Template:Development-Version](Template_Development-Version.md) | [Template:Disambig](Template_Disambig.md) | [Template:Docnav](Template_Docnav.md) |\n| [Template:Document objects navi](Template_Document_objects_navi.md) | [Template:Draft Tools navi](Template_Draft_Tools_navi.md) | [Template:Drawing Tools navi](Template_Drawing_Tools_navi.md) |\n| [Template:EM Tools navi](Template_EM_Tools_navi.md) | [Template:Emphasis](Template_Emphasis.md) | [Template:ExampleCode](Template_ExampleCode.md) |\n| [Template:FALSE](Template_FALSE.md) | [Template:False](Template_False.md) | [Template:FALSE/pl](Template_FALSE/pl.md) |\n| [Template:False/pl](Template_False/pl.md) | [Template:FEM Tools navi](Template_FEM_Tools_navi.md) | [Template:FileName](Template_FileName.md) |\n| [Template:Hello](Template_Hello.md) | [Template:Image Tools navi](Template_Image_Tools_navi.md) | [Template:Incode](Template_Incode.md) |\n| [Template:Interface navi](Template_Interface_navi.md) | [Template:KEY](Template_KEY.md) | [Template:LineEdit](Template_LineEdit.md) |\n| [Template:MacroCode](Template_MacroCode.md) | [Template:MenuCommand](Template_MenuCommand.md) | [Template:Mesh Tools navi](Template_Mesh_Tools_navi.md) |\n| [Template:Message](Template_Message.md) | [Template:Movie Tools navi](Template_Movie_Tools_navi.md) | [Template:Navigation menu 2](Template_Navigation_menu_2.md) |\n| [Template:OpenSCAD Tools navi](Template_OpenSCAD_Tools_navi.md) | [Template:Optional](Template_Optional.md) | [Organization chart](Organization_chart.md) |\n| [Template:Parameter](Template_Parameter.md) | [Template:Part Tools navi](Template_Part_Tools_navi.md) | [Template:PartDesign Tools navi](Template_PartDesign_Tools_navi.md) |\n| [Template:Plot Tools navi](Template_Plot_Tools_navi.md) | [Template:Points Tools navi](Template_Points_Tools_navi.md) | [Template:Powerdocnavi](Template_Powerdocnavi.md) |\n| [Template:Properties Title](Template_Properties_Title.md) | [Template:Properties Title/pl](Template_Properties_Title/pl.md) | [Template:PropertyData](Template_PropertyData.md) |\n| [Template:PropertyTasks](Template_PropertyTasks.md) | [Template:PropertyView](Template_PropertyView.md) | [Template:Raytracing Tools navi](Template_Raytracing_Tools_navi.md) |\n| [Release process](Release_process.md) | [Template:Robot Tools navi](Template_Robot_Tools_navi.md) | [Template:Sketcher Tools navi](Template_Sketcher_Tools_navi.md) |\n| [Template:Spreadsheet Tools navi](Template_Spreadsheet_Tools_navi.md) | [Template:Start Tools navi](Template_Start_Tools_navi.md) | [Template:Std Base navi](Template_Std_Base_navi.md) |\n| [Template:StdMenu](Template_StdMenu.md) | [Template:Surface Tools navi](Template_Surface_Tools_navi.md) | [Template:SystemInput](Template_SystemInput.md) |\n| [Template:SystemOutput](Template_SystemOutput.md) | [Template:TasksTag](Template_TasksTag.md) | [Template:TechDraw Tools navi](Template_TechDraw_Tools_navi.md) |\n| [Template:TitleTasks](Template_TitleTasks.md) | [Template:Top](Template_Top.md) | [Tracker](Tracker.md) |\n| [Template:TRUE](Template_TRUE.md) | [Template:True](Template_True.md) | [Template:TRUE/pl](Template_TRUE/pl.md) |\n| [Template:True/pl](Template_True/pl.md) | [Template:UnfinishedDocu](Template_UnfinishedDocu.md) | [Template:URL](Template_URL.md) |\n| [Template:URLn](Template_URLn.md) | [Template:Userdocnavi](Template_Userdocnavi.md) | [Template:Value](Template_Value.md) |\n| [Template:Variable](Template_Variable.md) | [Template:VeryImportantMessage](Template_VeryImportantMessage.md) | [Template:Web Tools navi](Template_Web_Tools_navi.md) |\n| [WikiPages](WikiPages.md) | [WikiRobots](WikiRobots.md) | [Category:Disambiguation](Category_Disambiguation.md) |\n| [Category:HouseKeeping](Category_HouseKeeping.md) | [Category:Pages to delete](Category_Pages_to_delete.md) | [Category:UnfinishedDocu](Category_UnfinishedDocu.md) |\n| [Category:Wiki](Category_Wiki.md) | [Category:Work in progress](Category_Work_in_progress.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Administration\n"} {"id": "freecad-docs:wiki/Category_Mesh.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Mesh.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Mesh.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ff9ffa7f28aaa598b24da596094726f7fd967712d0ff549caf62305c993c3497", "bytes": 4362, "tokens": 1976, "text": "# Category:Mesh\nThis category lists pages related to the [Mesh Workbench](Mesh_Workbench.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Artwork Mesh](Artwork_Mesh.md) | [Artwork MeshPart](Artwork_MeshPart.md) | [Asymptote](Asymptote.md) |\n| [Asymptote/pl](Asymptote/pl.md) | [Manual:Preparing models for 3D printing](Manual_Preparing_models_for_3D_printing.md) | [Mesh](Mesh.md) |\n| [Mesh AddFacet](Mesh_AddFacet.md) | [Mesh AddFacet/pl](Mesh_AddFacet/pl.md) | [Mesh BoundingBox](Mesh_BoundingBox.md) |\n| [Mesh BoundingBox/pl](Mesh_BoundingBox/pl.md) | [Mesh BuildRegularSolid](Mesh_BuildRegularSolid.md) | [Mesh BuildRegularSolid/pl](Mesh_BuildRegularSolid/pl.md) |\n| [Mesh CrossSections](Mesh_CrossSections.md) | [Mesh CrossSections/pl](Mesh_CrossSections/pl.md) | [Mesh CurvatureInfo](Mesh_CurvatureInfo.md) |\n| [Mesh CurvatureInfo/pl](Mesh_CurvatureInfo/pl.md) | [Mesh Decimating](Mesh_Decimating.md) | [Mesh Decimating/pl](Mesh_Decimating/pl.md) |\n| [Mesh Difference](Mesh_Difference.md) | [Mesh Difference/pl](Mesh_Difference/pl.md) | [Mesh EvaluateFacet](Mesh_EvaluateFacet.md) |\n| [Mesh EvaluateFacet/pl](Mesh_EvaluateFacet/pl.md) | [Mesh EvaluateSolid](Mesh_EvaluateSolid.md) | [Mesh EvaluateSolid/pl](Mesh_EvaluateSolid/pl.md) |\n| [Mesh Evaluation](Mesh_Evaluation.md) | [Mesh Evaluation/pl](Mesh_Evaluation/pl.md) | [Mesh Export](Mesh_Export.md) |\n| [Mesh Export/pl](Mesh_Export/pl.md) | [Mesh Feature](Mesh_Feature.md) | [Mesh Feature/pl](Mesh_Feature/pl.md) |\n| [Mesh FillInteractiveHole](Mesh_FillInteractiveHole.md) | [Mesh FillInteractiveHole/pl](Mesh_FillInteractiveHole/pl.md) | [Mesh FillupHoles](Mesh_FillupHoles.md) |\n| [Mesh FillupHoles/pl](Mesh_FillupHoles/pl.md) | [Mesh FlipNormals](Mesh_FlipNormals.md) | [Mesh FlipNormals/pl](Mesh_FlipNormals/pl.md) |\n| [Mesh FromPartShape](Mesh_FromPartShape.md) | [Mesh FromPartShape/pl](Mesh_FromPartShape/pl.md) | [Mesh HarmonizeNormals](Mesh_HarmonizeNormals.md) |\n| [Mesh HarmonizeNormals/pl](Mesh_HarmonizeNormals/pl.md) | [Mesh Import](Mesh_Import.md) | [Mesh Import/pl](Mesh_Import/pl.md) |\n| [Mesh Intersection](Mesh_Intersection.md) | [Mesh Intersection/pl](Mesh_Intersection/pl.md) | [Mesh Merge](Mesh_Merge.md) |\n| [Mesh Merge/pl](Mesh_Merge/pl.md) | [Mesh MeshObject](Mesh_MeshObject.md) | [Mesh MeshObject/pl](Mesh_MeshObject/pl.md) |\n| [Mesh PolyCut](Mesh_PolyCut.md) | [Mesh PolyCut/pl](Mesh_PolyCut/pl.md) | [Mesh PolyTrim](Mesh_PolyTrim.md) |\n| [Mesh PolyTrim/pl](Mesh_PolyTrim/pl.md) | [Mesh RemeshGmsh](Mesh_RemeshGmsh.md) | [Mesh RemeshGmsh/pl](Mesh_RemeshGmsh/pl.md) |\n| [Mesh RemoveCompByHand](Mesh_RemoveCompByHand.md) | [Mesh RemoveCompByHand/pl](Mesh_RemoveCompByHand/pl.md) | [Mesh RemoveComponents](Mesh_RemoveComponents.md) |\n| [Mesh RemoveComponents/pl](Mesh_RemoveComponents/pl.md) | [Mesh Scale](Mesh_Scale.md) | [Mesh Scale/pl](Mesh_Scale/pl.md) |\n| [Mesh Scripting](Mesh_Scripting.md) | [Mesh Scripting/pl](Mesh_Scripting/pl.md) | [Mesh SectionByPlane](Mesh_SectionByPlane.md) |\n| [Mesh SectionByPlane/pl](Mesh_SectionByPlane/pl.md) | [Mesh Segmentation](Mesh_Segmentation.md) | [Mesh Segmentation/pl](Mesh_Segmentation/pl.md) |\n| [Mesh SegmentationBestFit](Mesh_SegmentationBestFit.md) | [Mesh SegmentationBestFit/pl](Mesh_SegmentationBestFit/pl.md) | [Mesh Smoothing](Mesh_Smoothing.md) |\n| [Mesh Smoothing/pl](Mesh_Smoothing/pl.md) | [Mesh SplitComponents](Mesh_SplitComponents.md) | [Mesh SplitComponents/pl](Mesh_SplitComponents/pl.md) |\n| [Mesh to Part](Mesh_to_Part.md) | [Mesh to Part/pl](Mesh_to_Part/pl.md) | [Template:Mesh Tools navi](Template_Mesh_Tools_navi.md) |\n| [Mesh TrimByPlane](Mesh_TrimByPlane.md) | [Mesh TrimByPlane/pl](Mesh_TrimByPlane/pl.md) | [Mesh Union](Mesh_Union.md) |\n| [Mesh Union/pl](Mesh_Union/pl.md) | [Mesh VertexCurvature](Mesh_VertexCurvature.md) | [Mesh VertexCurvature/pl](Mesh_VertexCurvature/pl.md) |\n| [Mesh Workbench](Mesh_Workbench.md) | [Mesh Workbench/pl](Mesh_Workbench/pl.md) | [Mesh/pl](Mesh/pl.md) |\n| [MeshPart CreateFlatFace](MeshPart_CreateFlatFace.md) | [MeshPart CreateFlatFace/pl](MeshPart_CreateFlatFace/pl.md) | [MeshPart CreateFlatMesh](MeshPart_CreateFlatMesh.md) |\n| [MeshPart CreateFlatMesh/pl](MeshPart_CreateFlatMesh/pl.md) |\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [User_Documentation](Category_User_Documentation.md) > Category:Mesh\n"} {"id": "freecad-docs:wiki/Category_Template_Effect.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Template_Effect.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Template_Effect.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "630bb433d23078225e8b8a60ffa3a8284c5ae505afbe81cf0152f98d1fdbe119", "bytes": 614, "tokens": 225, "text": "# Category:Template:Effect\nThis category lists templates that produce an effect in the page without necessarily printing anything.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:Anchor](Template_Anchor.md) | [Template:Clear](Template_Clear.md) | [Template:Gloss](Template_Gloss.md) |\n| [Template:Glossend](Template_Glossend.md) | [Template:Prettytable](Template_Prettytable.md) | [Template:Softredirect](Template_Softredirect.md) |\n| [Template:TOCleft](Template_TOCleft.md) | [Template:TOCright](Template_TOCright.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Template:Effect\n"} {"id": "freecad-docs:wiki/Category_Template_Image.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Category_Template_Image.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Category_Template_Image.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "537174726ce42d0ef3852e169d4f65eefec28725904e18e41becb12cfa6e3063", "bytes": 283, "tokens": 101, "text": "# Category:Template:Image\nThis category lists templates that add images.\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Template:En](Template_En.md) | [Template:Screenshot](Template_Screenshot.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Template:Image\n"} {"id": "freecad-docs:wiki/Curves_Discretize.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Curves_Discretize.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Curves_Discretize.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "82f01581159ad3f6b5173505470170cc979fc77dae7cb7f016579dd931002db6", "bytes": 1135, "tokens": 424, "text": "---\n GuiCommand:\n Name: Curves Discretize\n MenuLocation: Curves , Discretize\n Workbenches: Curves_Workbench\n---\n\n# Curves Discretize\n\n## Description\n\nThe \"\" [Curves Discretize](Curves_Discretize.md) command allows to discretize an edge or a wire. This tool is part of the [external workbench](External_workbenches.md) called [Curves](Curves_Workbench.md).\n\n## Usage\n\n1. Switch to the \"\" [Curves](Curves_Workbench.md) workbench (install from \"\" [Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. To invoke the command, do one of the following:\n - Press the \"\" button in the Curves toolbar.\n - Use the **Curves → Discretize** entry in the dropdown menu.\n\n## Notes\n\n## Limitations\n\n## Properties\n\n## Scripting\n\n\n {{Curves Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Curves](Category_Curves.md) > Curves Discretize\n"} {"id": "freecad-docs:wiki/Curves_SegmentSurface.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Curves_SegmentSurface.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Curves_SegmentSurface.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c9dda1bebd45db0a4941ef0278fff89e8db5655132b7bf097c8041204520758b", "bytes": 1171, "tokens": 423, "text": "---\n GuiCommand:\n Name: Curves SegmentSurface\n MenuLocation: Surfaces , Segment surface\n Workbenches: Curves_Workbench\n---\n\n# Curves SegmentSurface\n\n## Description\n\nThe \"\" [Curves SegmentSurface](Curves_SegmentSurface.md) allows to segment a surface on isocurves. This tool is part of the [external workbench](External_workbenches.md) called [Curves](Curves_Workbench.md).\n\n## Usage\n\n1. Switch to the \"\" [Curves](Curves_Workbench.md) workbench (install from \"\" [Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. To invoke the command, do one of the following:\n - Press the \"\" button in the Curves toolbar.\n - Use the **Surfaces → Segment surface** entry in the dropdown menu.\n\n## Notes\n\n## Limitations\n\n## Properties\n\n## Scripting\n\n\n {{Curves Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Curves](Category_Curves.md) > Curves SegmentSurface\n"} {"id": "freecad-docs:wiki/DAG_view.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/DAG_view.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/DAG_view.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c534a875d69b9c152de29e428a52afefdd55bc203ddc1e79312e716a3b5cd090", "bytes": 2832, "tokens": 893, "text": "# DAG view\n## Introduction\n\n \n\nThe [DAG view](DAG_view.md) is a [directed acyclic graph](https://en.wikipedia.org/wiki/Directed_acyclic_graph) (DAG) that shows the relationships between different objects in the document. It is meant primarily to show how certain objects depend on others in a complex model with many features and references, such as those that can be created with the \"\" [PartDesign Workbench](PartDesign_Workbench.md).\n\nThe DAG view resembles the graph that can be produced from a Git repository and its branches. Together with the standard [tree view](tree_view.md) and the [dependency graph](Std_DependencyGraph.md), the DAG view is a tool to inspect the parametric history of objects in a document.\n\n## Example\n\nA simple model will be seen with different views.\n\n![](images/FreeCAD_DAG_view_3D.png ) \n*Model with 2D and 3D shapes.*\n\n\"\"\n\n\n*Left: objects shown in the standard [tree view](tree_view.md). Right: objects shown in the DAG view.*\n\n![](images/FreeCAD_DAG_view_Std_DependencyGraph.png )\n\n\n*Relationships between the objects shown in the [dependency graph](Std_DependencyGraph.md).*\n\n## Activating the DAG view \n\nThe DAG view was introduced in 0.17 as an experimental feature for power users and developers, so they could troubleshoot complex models; therefore, the DAG view is not available by default.\n\nTo use this view use the [parameter editor](Std_DlgParameter.md). Create the following subgroup if it doesn\\'t exist\n\n- `BaseApp/Preferences/DockWindows/DAGView`\n \n\nthen add the parameter `Enabled` of type `Boolean`, and set it to `True`.\n\nRestart FreeCAD and activate DAG view: **{{StdMenu|[View](Std_View_Menu.md)** → Panels → DAG view}}.\n\nIn the [parameter editor](Std_DlgParameter.md) you can also change some properties in the following subgroup\n\n- `BaseApp/Preferences/DAGView`\n \n\n- FontPointSize - Set size of text font and can help with readability with high DPI displays. Set to 0 for default font size.\n\n- SelectionMode\n - 0 - single click selects an item. Ctrl-click to add items to selection.\n - 1 - every click adds/removes item to selection.\n\n- Direction - the order in which items are displayed.\n - 1 - child on top, parent under it\n - -1 - parent on top, children under it\n\n## Links\n\n- [DAGView](https://forum.freecadweb.org/viewtopic.php?f=20&t=11276), forum thread presenting the new tool.\n- [easter egg of PartDesign Next: DAG View](https://forum.freecadweb.org/viewtopic.php?t=15375), including the view together with the update to PartDesign.\n\n\n{{Interface navi\n\n}} {{Std Base navi}}\n\n\n---\n⏵ [documentation index](../README.md) > DAG view\n"} {"id": "freecad-docs:wiki/DebianDevelopment.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/DebianDevelopment.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/DebianDevelopment.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bed14b55c743e206cb7d5fea8c41d22c14f0191cf5bd5d372649ee867ea8de1e", "bytes": 144, "tokens": 53, "text": "# DebianDevelopment\n1. REDIRECT [Debian development](Debian_development.md)\n\n\n---\n⏵ [documentation index](../README.md) > DebianDevelopment\n"} {"id": "freecad-docs:wiki/Defeaturing_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Defeaturing_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Defeaturing_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3bb194f179dae2a938019b4fff369b4d3d34538db6011b498bced197c70fb68f", "bytes": 9233, "tokens": 3695, "text": "# \"Defeaturing Defeaturing Workbench\n\n## Introduction\n\n \n\n\"\" [Defeaturing Workbench](Defeaturing_Workbench.md) is an add-on workbench intended for editing STEP models, removing of the selected features from the model. It is an [external workbench](External_Workbenches.md) and therefore not part of the standard FreeCAD install.\n\n## Features\n\n- Features a set of tools to edit a Shape or a STEP model, removing hole(s), face(s), simplifying the model, changing the tolerance, applying Fuzzy Boolean operations etc\\...\n- There are also tools to create more solid shape(s), from edge(s), face(s) or shell(s).\n- It is also possible to use direct modeling of the model, when the history of operations is unavailable. (This is the case for 3D STEP models).\n- Useful in situations to quickly remove proprietary details of the model before sharing it. See [Defeaturing](Defeaturing.md)\n\nNote: More advance Defeaturing tools can be used if [OCC7.3](OpenCASCADE.md) is available.\n\n## Installation\n\n### Automatic (recommended) \n\nUsing the FreeCAD \"\" [Addon Manager](Std_AddonMgr.md) available in v0.17+ via **Tools → Addon Manager**. Search for the \"\" Defeaturing workbench icon. The Addon Manager also notifies the user when a new version of this Addon is available.\n\n### Manually\n\nSee [How to install additional workbenches](How_to_install_additional_workbenches.md)\n\n### Supports\n\n- FreeCAD v0.15 4671\n- FreeCAD v0.16 \\>= 6712\n- FreeCAD v0.17 \\>= 13522\n- FreeCAD v0.18+\n\n## References\n\n- Author: Github: [\\@easyw](https://github.com/easyw) \\| FreeCAD Forums: [1](https://forum.freecadweb.org/viewtopic.php?f=9&t=29506)\n- Source code on github: \n- FC forum thread \n\n## Tools\n\n![Defeaturing tools dialog](images/Defeaturing_WB.png )\n\n\"\" Defeaturing Tools are located in a separate mask.\n\n- \"\" [Remove Holes](DefeatWB_Tools_rmv_hole.md): remove Hole from Face\n- \"\" [Remove listed Faces](DefeatWB_Tools_rmv_listed_Faces.md): remove \\'in List\\' Faces\n- \"\" [Add Faces from \\'in List\\' Edges](DefeatWB_Tools_add_Faces_listed_Edges.md): add Faces from \\'in List\\' Edges\n- \"\" [Select Faces to be Parametric defeatured](DefeatWB_Tools_select_Faces_Param_Defeat.md): select Faces to be Parametric defeatured\n- \"\" [Create a copy of the \\'in List\\' Edges ](DefeatWB_Tools_create_copy_listed_edges.md): create a copy of the \\'in List\\' Edges\n\n- \"\" [copy Faces from \\'in List\\' Faces ](DefeatWB_Tools_copy_Faces_listed_faces.md): copy Faces from \\'in List\\' Faces\n- \"\" [ offset face](DefeatWB_Tools_offset_face.md): offset face\n- \"\" [offset edge](DefeatWB_Tools_offset_edge.md): offset edge\n\n- \"\" [Make Solid from in List Faces](DefeatWB_Tools_make_solid_listed_faces.md): make Solid from in List Faces\n- \"\" [Make Solid from the Faces of the selected Objects](DefeatWB_Tools_make_solid_faces_selected_objects.md): make Solid from the Faces of the selected Objects\n- \"\" [Make Solid from in List Faces](DefeatWB_Tools_select_one_object_2_make_solid_step_proc.md): select ONE object to try to make a Solid through STEP import/export process\n- \"\" [Connect](DefeatWB_Tools_Connect.md): connect\n- \"\" [clean Face(s) removing holes and merging Outwire](DefeatWB_Tools_clean_face_rmv_holes.md): clean Face(s) removing holes and merging Outwire\n\n- \"\" [show \\'in List' Edge(s)](DefeatWB_Tools_show_listed_edges.md): show \\'in List' Edge(s)\n- \"\" [show \\'in List' Face(s)](DefeatWB_Tools_show_listed_faces.md): show \\'in List' Face(s)\n- \"\" [refine](DefeatWB_Tools_refine.md): refine\n- \"\" [simple copy](DefeatWB_Tools_simple_copy.md): simple copy\n- \"\" [parametric Refine](DefeatWB_Tools_parametric_refine.md): parametric Refine\n\n- \"\" [geometry check](DefeatWB_Tools_geometry_check.md): geometry check\n- \"\" [get Tolerance value](DefeatWB_Tools_get_Tolerance_value.md): get Tolerance value\n- \"\" [set Tolerance value](DefeatWB_Tools_set_Tolerance_value.md): set Tolerance value\n\n- \"\" [make Edge from selected Vertexes](DefeatWB_Tools_make_edges_selected_vertexes.md): make Edge from selected Vertexes\n- \"\" [reset Placement](DefeatWB_Tools_reset_placement.md): reset Placement\n- \"\" [show/hide TypeId of the Shape](DefeatWB_Tools_show_hide_typeId_shape.md): show/hide Type Id of the Shape\n- \"\" [help](DefeatWB_Tools_help.md): help\n\n- \"\" [Fuzzy Cut](DefeatWB_Tools_Fuzzy_Cut.md): Fuzzy Cut\n- \"\" [Fuzzy Union](DefeatWB_Tools_Fuzzy_Union.md): Fuzzy Union\n- \"\" [Fuzzy Common](DefeatWB_Tools_Fuzzy_Common.md): Fuzzy Common\n\n## Video Tutorials \n\n### Defeaturing\n\nRemoving Features using OCC7.3 new tools\n\n[480px\\|left\\|thumb \\|link=: removing-features (holes)](Image:Defeaturing-WB-@Work_v3.png.md)\n\n[480px\\|left\\|thumb \\|link= \\|alt=Defeaturing-WB-@Work\\|YouTube: Defeaturing tools - Simplifying the model](Image:Defeaturing-WB-@Work_v1.png.md)\n\n[480px\\|left\\|thumb \\|link=: Defeaturing tools - Multi-select faces for defeaturing](Image:Defeaturing-WB-@Work_v2.png.md)\n\n[480px\\|left\\|thumb \\|link= - removing-fillet-chamfer](Image:Defeaturing-WB-@Work_v4.png.md)\n\n[480px\\|left\\|thumb \\|link= - overview-features (in german language)](Image:Defeaturing-WB-@Work_v5.png.md)\n\n[480px\\|left\\|thumb \\|link= - parametric-defeaturing](Image:Defeaturing-WB-@Work_v6.png.md) \n\n### Repairing\n\n- Sew a Shape\n- Removing or Simplify Faces\n- Remove Holes or Pockets\n- Read or Change Tolerance\n- make Fuzzy Boolean operations\n\n## External workbenches \n\nFreeCAD workbenches are easy to program in [Python](Python.md), there are therefore many people developing additional workbenches outside of the FreeCAD main developers.\n\nThe [external workbenches](external_workbenches.md) page has some information and tutorials on some of them, and the [FreeCAD Addons](https://github.com/FreeCAD/FreeCAD-addons) project aims at gathering them and making them easily installable from within FreeCAD.\n\nNew workbenches are in development, stay tuned!\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > Defeaturing Workbench\n"} {"id": "freecad-docs:wiki/Design456_PartMerge.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Design456_PartMerge.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Design456_PartMerge.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0419170dfbebf331afe69a1144ba1d6de8d35783858a272e10e7e735054154bd", "bytes": 1276, "tokens": 466, "text": "---\n GuiCommand:\n Name: Design456 PartMerge\n MenuLocation: Design456_Tools , 3DTools , Merge\n Workbenches: Design456 Workbench\n Shortcut: None\n SeeAlso: \n---\n\n# Design456 PartMerge\n\n## Description\n\nThe \"\" **Part Merge** lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur at felis ut urna auctor pharetra id at nulla. This tool is part of the [external workbench](external_workbenches.md) called [Design456](Design456_Workbench.md).\n\n## Usage\n\n1. Switch to the \"\" [Design456](Design456_Workbench.md) workbench (install from \"\" [Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. Select two object to merge and run the \"\" Part Merge command. This is just an interface for the Part merge command. Nothing added to the command.\n\n## Limitations\n\nWorks on 3D objects.\n\n## Properties\n\n\n{{Properties_Title|Base}}\n\n## Scripting\n\n\n---\n⏵ [documentation index](../README.md) > [External_Command_Reference](Category_External_Command_Reference.md) > Design456 PartMerge\n"} {"id": "freecad-docs:wiki/Dialog_creation_setting_colors.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Dialog_creation_setting_colors.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Dialog_creation_setting_colors.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "967f63ff85b03b311854a34ce27b91fc9f9ed9ac53bd453024fc2d666300eb4d", "bytes": 11970, "tokens": 4653, "text": "# Dialog creation setting colors\n## Introduction\n\nThis is an example of [dialog creation](Dialog_creation.md) with [PySide](PySide.md).\n\nIn this example, the entire interface is defined in [Python](Python.md). Although this is possible for small interfaces, for larger interfaces the recommendation is to create **.ui** files through Qt Designer, and load these in the program.\n\n## Use QColorDialog to get a color \n\nComplete code: \n```python\n# -*- coding: utf-8 -*-\n# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html\nimport PySide\nfrom PySide import QtGui ,QtCore\nfrom PySide.QtGui import *\nfrom PySide.QtCore import *\npath = FreeCAD.ConfigGet(\"UserAppData\")\n\ncouleur = QtGui.QColorDialog.getColor()\nif couleur.isValid():\n red = int(str(couleur.name()[1:3]),16) # decode hexadecimal to int()\n green = int(str(couleur.name()[3:5]),16) # decode hexadecimal to int()\n blue = int(str(couleur.name()[5:7]),16) # decode hexadecimal to int()\n\n print(couleur) # \n print(\"hexadecimal \",couleur.name()) # color format hexadecimal mode 16\n print(\"Red color \",red) # color format decimal\n print(\"Green color \",green) # color format decimal\n print(\"Blue color \",blue) # color format decimal\n\n```\n\n## Use QColorDialog to create a palette of colors (standard and custom) \n\nThis example modify the Standard color and the Customize color with the Tango FreeCAD guide.\n\n \n```python\n# -*- coding: utf-8 -*-\n# https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QColor.html\nimport PySide\nfrom PySide import QtGui ,QtCore\nfrom PySide.QtGui import *\nfrom PySide.QtCore import *\n\n###############################################\n## Window colors organisation ##\n## __________________________ ##\n## StandardColor: ##\n## ##\n## Colonnes: ##\n## 1: 2: 3: 4: 5: 6: 7: 8: ##\n## _______________________________ ##\n## Line 1: 0 6 12 18 24 30 36 42 ##\n## Line 2: 1 7 13 19 25 31 37 43 ##\n## Line 3: 2 8 14 20 26 32 38 44 ##\n## Line 4: 3 9 15 21 27 33 39 45 ##\n## Line 5: 4 10 16 22 28 34 40 46 ##\n## Line 6: 5 11 17 23 29 35 41 47 ##\n## ##\n## CustomColor: ##\n## ##\n## Colonnes: ##\n## 1: 2: 3: 4: 5: 6: 7: 8: ##\n## _______________________________ ##\n## Line 1: 0 2 4 6 8 10 12 14 ##\n## Line 2: 1 3 5 7 9 11 13 15 ##\n## ##\n###############################################\n\ncolor_Dialog = QtGui.QColorDialog()\n# FreeCAD-Tango\n# Customize the colors in the standard box (in numeric mode)\n#\n#### Dialog line 1\ncolor_Dialog.setStandardColor( 0, QtGui.QColor(252, 233, 79 , 0).rgba()) # Butte 1\ncolor_Dialog.setStandardColor( 6, QtGui.QColor(237, 212, 0 , 0).rgba()) # Butte 2\ncolor_Dialog.setStandardColor(12, QtGui.QColor(196, 160, 0 , 0).rgba()) # Butte 3\ncolor_Dialog.setStandardColor(18, QtGui.QColor( 48, 43, 0 , 0).rgba()) # Butte 4\n\ncolor_Dialog.setStandardColor(24, QtGui.QColor(138, 226, 52 , 0).rgba()) # Chameleo 1\ncolor_Dialog.setStandardColor(30, QtGui.QColor(115, 210, 22 , 0).rgba()) # Chameleo 2\ncolor_Dialog.setStandardColor(36, QtGui.QColor( 78, 154, 6 , 0).rgba()) # Chameleo 3\ncolor_Dialog.setStandardColor(42, QtGui.QColor( 23, 42, 4 , 0).rgba()) # Chameleo 4\n#### Dialog line 2\ncolor_Dialog.setStandardColor( 1, QtGui.QColor(252, 175, 62 , 0).rgba()) # Orang 1\ncolor_Dialog.setStandardColor( 7, QtGui.QColor(245, 121, 0 , 0).rgba()) # Orang 2\ncolor_Dialog.setStandardColor(13, QtGui.QColor(206, 92, 0 , 0).rgba()) # Orang 3\ncolor_Dialog.setStandardColor(19, QtGui.QColor( 50, 25, 0 , 0).rgba()) # Orang 4\n\ncolor_Dialog.setStandardColor(25, QtGui.QColor(114, 159, 207 , 0).rgba()) # Sky Blu 1\ncolor_Dialog.setStandardColor(31, QtGui.QColor( 52, 101, 164 , 0).rgba()) # Sky Blu 2\ncolor_Dialog.setStandardColor(37, QtGui.QColor( 32, 74, 135 , 0).rgba()) # Sky Blu 3\ncolor_Dialog.setStandardColor(43, QtGui.QColor( 11, 21, 33 , 0).rgba()) # Sky Blu 4\n#### Dialog line 3\ncolor_Dialog.setStandardColor( 2, QtGui.QColor(173, 127, 168 , 0).rgba()) # Plu 1\ncolor_Dialog.setStandardColor( 8, QtGui.QColor(117, 80, 123 , 0).rgba()) # Plu 2\ncolor_Dialog.setStandardColor(14, QtGui.QColor( 92, 53, 102 , 0).rgba()) # Plu 3\ncolor_Dialog.setStandardColor(20, QtGui.QColor( 23, 16, 24 , 0).rgba()) # Plu 4\n\ncolor_Dialog.setStandardColor(26, QtGui.QColor(233, 185, 110 , 0).rgba()) # Chocolat 1\ncolor_Dialog.setStandardColor(32, QtGui.QColor(193, 125, 17 , 0).rgba()) # Chocolat 2\ncolor_Dialog.setStandardColor(38, QtGui.QColor(143, 89, 2 , 0).rgba()) # Chocolat 3\ncolor_Dialog.setStandardColor(44, QtGui.QColor( 39, 25, 3 , 0).rgba()) # Chocolat 4\n#### Dialog line 4\ncolor_Dialog.setStandardColor( 3, QtGui.QColor(239, 41, 41 , 0).rgba()) # Scarle Re 1\ncolor_Dialog.setStandardColor( 9, QtGui.QColor(204, 0, 0 , 0).rgba()) # Scarle Re 2\ncolor_Dialog.setStandardColor(15, QtGui.QColor(164, 0, 0 , 0).rgba()) # Scarle Re 3\ncolor_Dialog.setStandardColor(21, QtGui.QColor( 40, 0, 0 , 0).rgba()) # Scarle Re 4\n\ncolor_Dialog.setStandardColor(27, QtGui.QColor( 52, 224, 226 , 0).rgba()) # FreeTea 1\ncolor_Dialog.setStandardColor(33, QtGui.QColor( 22, 208, 210 , 0).rgba()) # FreeTea 2\ncolor_Dialog.setStandardColor(39, QtGui.QColor( 6, 152, 154 , 0).rgba()) # FreeTea 3\ncolor_Dialog.setStandardColor(45, QtGui.QColor( 4, 42, 42 , 0).rgba()) # FreeTea 4\n#### Dialog line 5\ncolor_Dialog.setStandardColor( 4, QtGui.QColor(255, 255, 255 , 0).rgba()) # Snow White\n\ncolor_Dialog.setStandardColor(10, QtGui.QColor(238, 238, 236 , 0).rgba()) # Aluminiu 1\ncolor_Dialog.setStandardColor(16, QtGui.QColor(211, 215, 207 , 0).rgba()) # Aluminiu 2\ncolor_Dialog.setStandardColor(22, QtGui.QColor(186, 189, 182 , 0).rgba()) # Aluminiu 3\n\ncolor_Dialog.setStandardColor(28, QtGui.QColor(136, 138, 133 , 0).rgba()) # Aluminiu 4\ncolor_Dialog.setStandardColor(34, QtGui.QColor( 85, 87, 83 , 0).rgba()) # Aluminiu 5\ncolor_Dialog.setStandardColor(40, QtGui.QColor( 46, 52, 54 , 0).rgba()) # Aluminiu 6\n\ncolor_Dialog.setStandardColor(46, QtGui.QColor( 0, 0, 0 , 0).rgba()) # Je Black\n#### Dialog line 6\ncolor_Dialog.setStandardColor( 5, QtGui.QColor(255, 255, 255 , 0).rgba()) # Snow White\ncolor_Dialog.setStandardColor(11, QtGui.QColor(255, 0, 0 , 0).rgba()) # Aluminiu 1\ncolor_Dialog.setStandardColor(17, QtGui.QColor( 0, 255, 0 , 0).rgba()) # Aluminiu 2\ncolor_Dialog.setStandardColor(23, QtGui.QColor( 0, 0, 255 , 0).rgba()) # Aluminiu 3\n\ncolor_Dialog.setStandardColor(29, QtGui.QColor(255, 255, 0 , 0).rgba()) # Aluminiu 4\ncolor_Dialog.setStandardColor(35, QtGui.QColor(255, 0, 255 , 0).rgba()) # Aluminiu 5\ncolor_Dialog.setStandardColor(41, QtGui.QColor( 0, 255, 255 , 0).rgba()) # Aluminiu 6\ncolor_Dialog.setStandardColor(47, QtGui.QColor( 0, 0, 0 , 0).rgba()) # Je Black\ncolor_Dialog.setStandardColor(47, QtGui.QColor( 0, 0, 0 , 0).rgba()) # Je Black\n\n#### Customize the colors to Dialog CustomColor (in hexadecimal converted in numeric mode)\n# Use the Yellow tones for tools that create objects.\n# Dialog line 1\ncolor_Dialog.setCustomColor(0, QtGui.QColor( int(\"fc\",16),int(\"e9\",16),int(\"4f\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(2, QtGui.QColor( int(\"ed\",16),int(\"d4\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(4, QtGui.QColor( int(\"c4\",16),int(\"a0\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(6, QtGui.QColor( int(\"30\",16),int(\"2b\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\n\n# Use the Blue tones for tools that modify objects\ncolor_Dialog.setCustomColor(8, QtGui.QColor( int(\"72\",16),int(\"9f\",16),int(\"cf\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(10,QtGui.QColor( int(\"34\",16),int(\"65\",16),int(\"a4\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(12,QtGui.QColor( int(\"20\",16),int(\"4a\",16),int(\"87\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(14,QtGui.QColor( int(\"0b\",16),int(\"15\",16),int(\"21\",16) , 0).rgba()) # hexadecimal converted in int\n\n# Use the Teal tones for view-related tools\n# Dialog line 2\ncolor_Dialog.setCustomColor(1, QtGui.QColor( int(\"34\",16),int(\"e0\",16),int(\"e2\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(3, QtGui.QColor( int(\"16\",16),int(\"d0\",16),int(\"d2\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(5, QtGui.QColor( int(\"06\",16),int(\"98\",16),int(\"9a\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(7, QtGui.QColor( int(\"04\",16),int(\"2a\",16),int(\"2a\",16) , 0).rgba()) # hexadecimal converted in int\n\n# Use the Red tones for Constraint related tools\ncolor_Dialog.setCustomColor(9, QtGui.QColor( int(\"ef\",16),int(\"29\",16),int(\"29\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(11,QtGui.QColor( int(\"cc\",16),int(\"00\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(13,QtGui.QColor( int(\"a4\",16),int(\"00\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\ncolor_Dialog.setCustomColor(15,QtGui.QColor( int(\"28\",16),int(\"00\",16),int(\"00\",16) , 0).rgba()) # hexadecimal converted in int\n\nColor = color_Dialog.getColor() # Color.name() extract the color in Hexadecimal mode (#ad7fa8)\n\nif Color.isValid():\n\n print(\"__.name()___________\")\n print(\"hexadecimal \", Color.name()) # color format hexadecimal mode 16\n red = int(str( Color.name()[1:3]),16 ) # decode hexadecimal to int()\n green = int(str( Color.name()[3:5]),16 ) # decode hexadecimal to int()\n blue = int(str( Color.name()[5:7]),16 ) # decode hexadecimal to int()\n\n print(\"Red color decimal \", str( Color.name()[1:3]), red ) # color format hex to decimal\n print(\"Green color decimal \", str( Color.name()[3:5]), green )# color format hex to decimal\n print(\"Blue color decimal \", str( Color.name()[5:7]), blue ) # color format hex to decimal\n\n print(\"__.red()____________\")\n print(\"Red color decimal \", Color.red() ) # extract the color RGBa with Qt (0 to 255)\n print(\"Green color decimal \", Color.green() ) # extract the color RGBa with Qt (0 to 255)\n print(\"Blue color decimal \", Color.blue() ) # extract the color RGBa with Qt (0 to 255)\n print(\"Alpha decimal \", Color.alpha() ) # extract the color RGBa with Qt (0 to 255)\n\n print(\"__.redF()___________\")\n print(\"Red color float \", Color.redF() ) # extract the color RGBa with Qt (0.0 to 1.0) as FreeCAD\n print(\"Green color float \", Color.greenF() ) # extract the color RGBa with Qt (0.0 to 1.0) as FreeCAD\n print(\"Blue color float \", Color.blueF() ) # extract the color RGBa with Qt (0.0 to 1.0) as FreeCAD\n print(\"Alpha float \", Color.alphaF() ) # extract the color RGBa with Qt (0.0 to 1.0) as FreeCAD\n print(\"__enjoy_____________\")\n\nelse:\n Color = \"\"\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Python Code](Category_Python%20Code.md) > Dialog creation setting colors\n"} {"id": "freecad-docs:wiki/Draft_Center.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Center.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Center.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bda299b82bbbe9f3ad68e51ca95e7ffd27b94bda104384aa291cbe61d59fd228", "bytes": 162, "tokens": 71, "text": "# Draft Center\n1. REDIRECT [Draft_Snap_Center](Draft_Snap_Center.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Center\n"} {"id": "freecad-docs:wiki/Draft_Select.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Select.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Select.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "22a7c6e7f5cf1a8eba178b762001e1abec15b94ac17e3e522a9c50476fc0f903", "bytes": 162, "tokens": 65, "text": "# Draft Select\n1. REDIRECT [Selection_methods](Selection_methods.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Select\n"} {"id": "freecad-docs:wiki/Draft_ShapeString.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_ShapeString.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_ShapeString.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "90241d92ae6c069ba5b5fdc66386d46a5864de0f7af4a81c17351163d9459909", "bytes": 9799, "tokens": 3129, "text": "---\n GuiCommand:\n Name: Draft ShapeString\n MenuLocation: Drafting , Shape from text
Annotation , Shape from text\n Workbenches: Draft_Workbench, BIM_Workbench\n Shortcut: \n Version: 0.14\n SeeAlso: Draft_Text, Draft_Label, Part_Extrude\n---\n\n# Draft ShapeString\n\n## Description\n\nThe \"\" **Draft ShapeString** command creates a compound shape that represents a text string. This shape can be used to create 3D letters with the [Part Extrude](Part_Extrude.md) command.\n\nThe Draft ShapeString command is not intended for standard text annotations. The [Draft Text](Draft_Text.md) command or the [Draft Label](Draft_Label.md) command should be used for that purpose.\n\n ![](images/Draft_ShapeString_Example400.png ) \n*Single point required to position the ShapeString*\n\n## Usage\n\nFor Windows users: please read the [Font file selection on Windows](#Font_file_selection_on_Windows.md) paragraph first.\n\n1. There are several ways to invoke the command:\n - Press the ** [Shape from text](Draft_ShapeString.md)** button.\n - [Draft](Draft_Workbench.md): Select the **Drafting → Shape from text** option from the menu.\n - [BIM](BIM_Workbench.md): Select the **Annotation → Shape from text** option from the menu.\n2. The **ShapeString** task panel opens.\n3. Click a point in the [3D view](3D_view.md), or type coordinates.\n4. Optionally press the **Reset Point** button to reset the point to the origin.\n5. Enter a **String**.\n6. Specify the **Height**.\n7. To select a font do one of the following:\n - Enter a file path in the **Font file** input box.\n - Press the **...** button and select a file.\n8. Press the **OK** button to finish the command.\n9. Optionally change the **Justification** of the ShapeString. See [Properties](#Properties.md).\n\n## Options\n\n- Press **Esc** or the **Cancel** button to abort the command.\n\n## Relative font path \n\n\n(v1.1) \n\nIt is possible to specify a relative path for the font file. For this the FreeCAD document must have been saved at least once.\n\nSome examples:\n\n- **./SomeFont.ttf**: The font file is in the same directory as the document.\n\n- **./MyDirectory/SomeFont.ttf**: The font file is in the **MyDirectory** sub-directory of the document directory.\n\n- **../SomeFont.ttf**: The font file is in the parent directory of the document directory.\n\n## Font file selection on Windows \n\nOn Windows access to the default font folder is restricted. This affects the font file selection for ShapeStrings. There are three cases in FreeCAD where a font file for ShapeStrings can be specified: in the ShapeString task panel, when changing the **Font File** property of a ShapeString, and when specifying the default font file in the [Draft Preferences](Draft_Preferences#Texts_and_dimensions.md).\n\nPressing the **...** button and then selecting a file from the default Windows font folder is not possible when using the native file dialog. There are a number of workarounds:\n\n- Make sure **DontUseNativeFontDialog** is set to {{True}}, which is the default value for this preference. This will only call a different, non-native, file dialog when pressing the **...** button in the ShapeString task panel. With this file dialog the default Windows font folder can be accessed.\n- Change **DontUseNativeDialog** to {{True}}. This instructs FreeCAD to always use the non-native file dialog.\n- Specify the font file in the input box. You can of course type the full path or copy-paste the path from the Windows File Explorer. But there is also another way to enter the path. If you enter {{Value|C:\\}} a dropdown list will appear. Select {{Value|Windows}} from that list and add {{Value|\\F}}. Select {{Value|Fonts}} from the new dropdown list. Finally add {{Value|\\}} and the first letter(s) of the font file, and then select it from the dropdown list.\n- Create a custom folder for your font files.\n\nSee the [Preferences](#Preferences.md) paragraph below for the location of the mentioned preferences.\n\n## Notes\n\n- A Draft ShapeString can be edited by double-clicking it in the [Tree view](Tree_view.md).\n- Supported fonts include TrueType (**.ttf**), OpenType (**.otf**) and Type 1 (**.pfb**).\n- The command is restricted to left-to-right text. Right-to-left and top-to-bottom text are not supported.\n- Very small text heights may result in deformed character shapes due to loss of detail in scaling.\n- Fonts can generate problematic geometry. This is because font contours are allowed to overlap and have small gaps. These conditions are considered errors in wires used to define faces.\n- Draft ShapeStrings can also be created with the [Macro Fonts Win10 PYMP](Macro_Fonts_Win10_PYMP.md).\n- To create Draft ShapeStrings arranged in a circular fashion use the [Macro FCCircularText](Macro_FCCircularText.md).\n\n## Tutorials\n\n- [Draft ShapeString tutorial](Draft_ShapeString_tutorial.md): extrude a ShapeString, position it in 3D space, and create an engraving in another body.\n- [How to use ShapeStrings in PartDesign](https://forum.freecadweb.org/viewtopic.php?f=3&t=36623)\n\n## Preferences\n\nSee also: [Preferences Editor](Preferences_Editor.md), [Draft Preferences](Draft_Preferences.md) and [Std DlgParameter](Std_DlgParameter.md).\n\n- The default font file can be changed in the preferences: **Edit → Preferences... → Draft → Texts and dimensions → Default ShapeString font file**.\n- For Windows users:\n - Set **Tools → Edit parameters... → BaseApp → Preferences → Dialog → DontUseNativeFontDialog** to {{True}} to use the non-native file dialog when selecting a font file from the ShapeString task panel.\n - Alternatively, set **Tools → Edit parameters... → BaseApp → Preferences → Dialog → DontUseNativeDialog** to {{True}} to always use the non-native file dialog.\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nA Draft ShapeString object is derived from a [Part Part2DObject](Part_Part2DObject.md) and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{TitleProperty|Draft}}\n\n- **Font File|File**: Font file name.\n\n- **Fuse|Bool**: Fuse faces if faces overlap, usually not required (can be very slow). Ignored if **Make Face** is `False`. (v1.0) \n\n- **Justification|Enumeration**: Horizontal and vertical alignment. Options: {{value|Top-Left}}, {{value|Top-Center}}, {{value|Top-Right}}, {{value|Middle-Left}}, {{value|Middle-Center}}, {{value|Middle-Right}}, {{value|Bottom-Left}}, {{value|Bottom-Center}}, {{value|Bottom-Right}}. (v1.0) \n\n- **Justification Reference|Enumeration**: Height reference used for justification. Options: {{value|Cap Height}}, {{value|Shape Height}}. The shape height depends on the characters in **String**. (v1.0) \n\n- **Keep Left Margin|Bool**: Keep left margin and leading white space when justification is left. (v1.0) \n\n- **Make Face|Bool**: Fill letters with faces.\n\n- **Oblique Angle|Angle**: Oblique (slant) angle. Must be in the -80° to +80° range. (v1.0) \n\n- **Scale To Size|Bool**: Scale to ensure cap height is equal to size. If set to `False`, depending on the font, cap height will not match **Size** exactly. (v1.0) \n\n- **Size|Length**: Height of text.\n\n- **String|String**: Text string. A ShapeString can only display a single text line.\n\n- **Tracking|Distance**: Inter-character spacing. (v1.0) : The property type has been updated.\n\n \"\" \n*The height of the red rectangle (solid line) is equal to the cap height.
\nThe height of the green rectangle (dashed line) is equal to the shape height.
\nThe corners, the midpoints of the edges, and the center of the rectangles
\nmatch the 9 justification options: Top-Left to Bottom-Right.*\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nTo create a Draft ShapeString use the `make_shapestring` method ((v0.19) ) of the Draft module. This method replaces the deprecated `makeShapeString` method.\n\n \n```python\nshapestring = make_shapestring(String, FontFile, Size=100, Tracking=0)\n```\n\n- Creates a `shapestring` compound shape using the specified `String` and the full path of a supported `FontFile`.\n\n- `Size`is the height of the resulting text in millimeters.\n\n- `Tracking`is the inter-character spacing in millimeters.\n\nThe placement of the ShapeString can be changed by overwriting its `Placement` attribute, or by individually overwriting its `Placement.Base` and `Placement.Rotation` attributes.\n\nExample:\n\n \n```python\nimport FreeCAD as App\nimport Draft\n\ndoc = App.newDocument()\n\nfont1 = \"/usr/share/fonts/truetype/msttcorefonts/Arial.ttf\"\nfont2 = \"/usr/share/fonts/truetype/dejavu/DejaVuSerif.ttf\"\nfont3 = \"/usr/share/fonts/truetype/freefont/FreeSerifItalic.ttf\"\n\nS1 = Draft.make_shapestring(\"This is a sample text\", font1, 200)\n\nS2 = Draft.make_shapestring(\"Inclined text\", font2, 200, 10)\n\nzaxis = App.Vector(0, 0, 1)\np2 = App.Vector(-1000, 500, 0)\nplace2 = App.Placement(p2, App.Rotation(zaxis, 45))\nS2.Placement = place2\n\nS3 = Draft.make_shapestring(\"Upside-down text\", font3, 200, 10)\nS3.Placement.Base = App.Vector(0, -1000, 0)\nS3.Placement.Rotation = App.Rotation(zaxis, 180)\n\ndoc.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft ShapeString\n"} {"id": "freecad-docs:wiki/Draft_Special.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_Special.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_Special.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7b36cbd5721264bf14d9142cdb2469ffa448fdcce2d8d2d71ef5f118e72b10b6", "bytes": 166, "tokens": 71, "text": "# Draft Special\n1. REDIRECT [Draft_Snap_Special](Draft_Snap_Special.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Special\n"} {"id": "freecad-docs:wiki/Draft_SubelementHighlight.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_SubelementHighlight.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_SubelementHighlight.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1f91b53d785afd224a0a9f224a8aaddb7edec7d4dfb35a9522fcee6f431c9f5b", "bytes": 2768, "tokens": 850, "text": "---\n GuiCommand:\n Name: Draft SubelementHighlight\n MenuLocation: Modification , Subelement highlight\n Workbenches: Draft_Workbench\n Shortcut: **H** **S**\n Version: 0.19\n SeeAlso: Draft_Move, Draft_Rotate, Draft_Scale\n---\n\n# Draft SubelementHighlight\n\n## Description\n\nThe \"\" **Draft SubelementHighlight** command temporarily highlights selected objects, or the base objects of selected objects. It is intended to be used in conjunction with the subelement mode of the [Draft Move](Draft_Move.md) command, the [Draft Rotate](Draft_Rotate.md) command or the [Draft Scale](Draft_Scale.md) command. Currently subelement mode only works properly for [Draft Lines](Draft_Line.md) and [Draft Wires](Draft_Wire.md).\n\n ![](images/Draft_SubelementHighlight_example.png ) \n*An Arch Wall whose base, a Draft Wire, has been highlighted*\n\n## Usage\n\n1. Optionally select one or more [Draft Lines](Draft_Line.md) or [Draft Wires](Draft_Wire.md), or objects whose **Base** objects are [Draft Lines](Draft_Line.md) or [Draft Wires](Draft_Wire.md).\n2. There are several ways to invoke the command:\n - Press the ** [Subelement highlight](Draft_SubelementHighlight.md)** button.\n - Select the **Modification → Subelement highlight** option from the menu.\n - Use the keyboard shortcut: **H** then **S**.\n3. If you have not yet selected an object: select an object in the [3D view](3D_view.md).\n4. The selected objects are made visible (if required), their **Line Color** and **Point Color** are changed to red, and their **Point Size** is changed to {{Value|10}}.\n5. It is advisable to now deselect the existing selection, for example by clicking a random point in the [3D view](3D_view.md).\n6. Select one or more subelements, edges or points, of the objects that have been marked in red.\n7. Invoke [Draft Move](Draft_Move.md), [Draft Rotate](Draft_Rotate.md) or [Draft Scale](Draft_Scale.md).\n8. Toggle subelement mode in the task panel of that command by checking the **Modify subelements** checkbox.\n9. Modify the selected sublements and complete the Draft modify command.\n10. Press **Esc** to revert the temporary visual changes of the objects.\n\n## Notes\n\n- If objects have been highlighted with this command the temporary visual changes should be reverted before saving and reopening the file.\n- Highlighted objects should not be copied if subelement mode is off. The temporary visual changes cannot be reverted for copies created in this manner.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft SubelementHighlight\n"} {"id": "freecad-docs:wiki/Draft_ToggleGrid.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Draft_ToggleGrid.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Draft_ToggleGrid.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6c1b09eacc6ce8f84ab3a0eeb437c3ae5d5b93d0f75a574c1d175d64a537cba9", "bytes": 2578, "tokens": 819, "text": "---\n GuiCommand:\n Name: Draft ToggleGrid\n MenuLocation: Utilities , Toggle grid
Snapping , Toggle grid\n Workbenches: Draft_Workbench, BIM_Workbench\n Shortcut: **G** **R**\n SeeAlso: Draft_Snap_Grid, Draft_SelectPlane\n---\n\n# Draft ToggleGrid\n\n## Description\n\nThe \"\" **Draft ToggleGrid** command changes the visibility of the grid.\n\n\n(v1.0) \n\n: Each [3D view](3D_view.md) has its own grid that can either always be visible, only be visible during commands, or invisible. The initial visibility of the grid in new views depends on the [preferences](#Preferences.md).\n\n## Usage\n\n1. The command can be used while another command is active.\n2. There are several ways to invoke the command:\n - Press the ** [Toggle grid](Draft_ToggleGrid.md)** button in the Draft snap toolbar.\n - [Draft](Draft_Workbench.md): Press the ** [Toggle grid](Draft_ToggleGrid.md)** button in the [Draft snap widget](Draft_snap_widget.md).\n - Draft: Select the **Utilities → Toggle grid** option from the menu, or from the [Tree view](Tree_view.md) or [3D view](3D_view.md) context menu.\n - [BIM](BIM_Workbench.md): Select the **Snapping → Toggle grid** option from the menu, or from the 3D view context menu.\n - Use the keyboard shortcut: **G** then **R**. This shortcut cannot be used if another command is active.\n3. The visibility of the grid belonging to the current 3D view has changed:\n - If no other command is active:\n - If the grid was invisible it is now always visible.\n - If the grid was visible it is now no longer always visible, but the grid\\'s visibility during commands remains unchanged.\n - If another command is active:\n - If the grid was invisible it is now only visible during commands.\n - If the grid was visible it is now no longer visible during commands and no longer always visible.\n\n## Preferences\n\nSee also: [Preferences Editor](Preferences_Editor.md) and [Draft Preferences](Draft_Preferences.md).\n\n- Several grid preferences are available: **Edit → Preferences... → Draft → Grid and snapping**.\n- To keep the grid when switching to other workbenches see [Fine-tuning](Fine-tuning#Draft_Workbench.md).\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft ToggleGrid\n"} {"id": "freecad-docs:wiki/EM_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/EM_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/EM_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "92659a855806a8bec3702f35161c575785368070c27d378b44a7e7f28b6597ff", "bytes": 4955, "tokens": 1741, "text": "# \"EM EM Workbench\n\n \n\n## Introduction\n\nThe EM (ElectroMagnetic) Workbench provides the CAD front-end interface to some open source free solvers. At present it supports the 3D magnetoquasistatic impedance solver [FastHenry](https://www.fastfieldsolvers.com/software.htm#fasthenry2) (i.e. inductance and resistance extraction at \\\"low\\\" frequencies). Support for the 3D electrostatic capacitance solver [FasterCap](https://www.fastfieldsolvers.com/software.htm#fastercap) is ongoing.\n\n\"\"\n\n## Installation\n\nThe [EM Workbench](EM_Workbench.md) is an [external workbench](External_workbenches.md), that can be installed from the FreeCAD \"\" [Addon Manager](Std_AddonMgr.md). This can be done via the **Tools → Addon Manager** menu.\n\nThe electromagnetic solvers FastHenry2 and FasterCap must be installed separately. Their binary codes as well as the sources are freely available from [FastFieldSolvers](https://www.fastfieldsolvers.com).\n\n## Usage\n\n### FastHenry\n\nFastHenry is a software for computing the frequency-dependant self and mutual inductances and resistances of a generic tridimensional conductive structure, in the magnetoquasistatic approximation. It can also generate Spice-compatible, multiple-frequency equivalent-circuit models.\n\nKnowledge of FastHenry is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FastHenry. We suggest you to read the original [FastHenry User\\'s manual](https://www.fastfieldsolvers.com/documentation.htm) and play a bit with the sample files that are provided with the installation.\n\n### FasterCap\n\nFasterCap is a powerful three- and two-dimensional capacitance extraction program.\n\nKnowledge of FasterCap is a pre-condition for the proficient usage of the ElectroMagnetic Workbench for FasterCap. We suggest you to read the original [FasterCap help file](https://www.fastfieldsolvers.com/documentation.htm) and play a bit with the sample files that are provided with the installation.\n\n## FastHenry Tools \n\nThese are tools used to interface with FastHenry:\n\n- \"\" [FHNode](EM_FHNode.md): Creates a FastHenry Node object\n- \"\" [FHSegment](EM_FHSegment.md): Creates a FastHenry Segment object\n- \"\" [FHPath](EM_FHPath.md): Creates a FastHenry Path object\n- \"\" [FHPlane](EM_FHPlane.md): Creates a FastHenry uniform conductive Plane object\n- \"\" [FHPlaneHole](EM_FHPlaneHole.md): Creates a FastHenry uniform conductive plane Hole object\n- \"\" [FHPlaneAddRemoveNodeHole](EM_FHPlaneAddRemoveNodeHole.md): Add or Remove a Node or a Hole from/to a conductive plane\n- \"\" [FHEquiv](EM_FHEquiv.md): Creates a FastHenry node Equivalence object\n- \"\" [FHPort](EM_FHPort.md): Creates a FastHenry Port object\n- \"\" [FHSolver](EM_FHSolver.md): Creates a FastHenry Solver object\n- \"\" [FHInputFIle](EM_FHInputFile.md): Creates a FastHenry Input File\n\n## FasterCap Tools \n\nAt present, FasterCap is supported via some Macros in the **Export_mesh.py** file available in the [ElectroMagnetic Workbench GitHub source code](https://github.com/ediloren/EM-Workbench-for-FreeCAD).\n\n## API\n\nThe EM tools can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the EM API.\n\n## Tutorials\n\nSome video tutorials are available for the EM Workbench beta versions:\n\n- [FreeCAD ElectroMagnetic Workbench tutorial - Getting started](https://www.youtube.com/watch?v=h6Pp-_ovLZM)\n- [FreeCAD ElectroMagnetic WorkBench tutorial: create a conductive plane, part 1](https://www.youtube.com/watch?v=5pSzPizw4e8)\n- [FreeCAD ElectroMagnetic WorkBench tutorial: create a conductive plane, part 2](https://www.youtube.com/watch?v=BeBNtfH25rM)\n- [FreeCAD ElectroMagnetic WorkBench tutorial: create a conductive plane, part 3](https://www.youtube.com/watch?v=BtgdJOf-ql0)\n- [FreeCAD ElectroMagnetic WorkBench tutorial: using the path object, part 1](https://www.youtube.com/watch?v=CRqDuEtbdds)\n- [FreeCAD ElectroMagnetic WorkBench tutorial: using the path object, part 2](https://www.youtube.com/watch?v=slsLdLoF2OI)\n\n {{EM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [External Workbenches](Category_External%20Workbenches.md) > [EM](Category_EM.md) > EM Workbench\n"} {"id": "freecad-docs:wiki/Example_Slab_Having_Mesh_Of_Straight_Rebars.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Example_Slab_Having_Mesh_Of_Straight_Rebars.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Example_Slab_Having_Mesh_Of_Straight_Rebars.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7c548330a3bbf4bf0a4cf4707d61ac456c2744b2a553b6c06a5d6bb5cb79746f", "bytes": 11131, "tokens": 3433, "text": "---\n TutorialInfo:\n Topic: Example Slab Having Mesh Of Straight Rebars\n Level: Intermediate\n Time: \n Author: Shiv Charan\n FCVersion: 0.20\n Files: \n---\n\n# Example Slab Having Mesh Of Straight Rebars\n\n \n\n\n## Description\n\nThe \"\" [Reinforcement SlabRebars](Reinforcement_SlabRebars.md) tool allows the user to create reinforcing bars inside a Slab [Arch Structure](Arch_Structure.md) object.\n\nThis tool is part of the \"\" [Reinforcement Workbench](Reinforcement_Workbench.md), an [external workbench](External_workbenches.md) that can be installed with the \"\" [Addon Manager](Std_AddonMgr.md).\n\nIn this example we will create Slab Reinforcement for Slab having Mesh of Straight Rebars (straight rebars in both parallel and cross direction ) as shown in below figure.\n\n \"\" \n*A Example of Slab Reinforcement of Slab Spanning having Straight Rebars in Slab [Arch Structure](Arch_Structure.md)*\n\n## Usage\n\n1\\. Select any face of a previously created Slab ** [Arch Structure](Arch_Structure.md)** object. as shown in below image.\n\n \"\" \n*Selected face for Slab Arch Structure*\n\n2\\. Then select ** [Slab Reinforcement](Reinforcement_SlabRebars.md)** from the rebar tools.\n\n3\\. A dialog box will pop-out on screen as shown below.\n\n\n: ![](images/Slab_Reinforcement_input_dialog_box.png )\n\n\n: \n \n*Dialog Box for the Slab Reinforcement*\n \n\n4\\. Select the desired type of cover of reinforcement mesh (Top or Bottom) In example Bottom is selected.\n\n5\\. Select the StraightRebar rebar type and other input data for rebars in parallel direction of selected face as show in below image.\n\n\n: ![](images/Straight_Rebars_in_parallel_for_Slab_Spanning_in_One_Direction.png )\n\n\n: \n \n*Dialog Box for Slab Reinforcement of the Rebars in parallel direction of selected face*\n \n\n6\\. Now click on **Next** button or select Cross Rebars in list view.\n\n7\\. Now select StraightRebar rebar type and other desired data for input data for rabars in cross direction of selected face as show in below image.\n\n\n: ![](images/Straight_rebars_in_cross_direction.png )\n\n\n: \n \n*Dialog Box for Slab Reinforcement of the Rebars in cross direction of selected face*\n \n\n8\\. Click **OK** or **Apply** or **Finish** to generate Slab reinforcement.\n\n9\\. Click **Cancel** to exit the dialog box.\n\n## Properties Used for Slab Spanning in One direction \n\n**Properties for Rebars in Parallel Direction to selected face:**\n\n- **Mesh Cover Along**: It represent alignment of rebar mesh along top or bottom face of structure. It can have two values \\\"Top\\\" and \\\"Bottom\\\".\n\n- **Rebar Type**: Type of rebar for parallel rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **Front Cover**: The distance between parallel rebar and selected face.\n\n- **Left Cover**: The distance between the left end of the parallel rebar to the left face of the structure.\n\n- **Right Cover**: The distance between the right end of the parallel rebar to right face of the structure.\n\n- **Bottom Cover**: The distance between parallel rebars from the bottom face of the structure.\n\n- **Top Cover**: The distance between parallel rebars from the top face of the structure.\n\n- **Rear Cover**: Rear cover for slab reinforcement of parallel rebars.\n\n- **Diameter**: Diameter of parallel rebars\n\n- **Amount**: It contains count of parallel rebars.\n\n- **Spacing**: It contains spacing between parallel rebars.\n\n**Properties for Rebars in Cross Direction to selected face:**\n\n- **Rebar Type**: Type of rebar for cross rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **Front Cover**: The distance between cross rebar and selected face.\n\n- **Left Cover**: The distance between the left end of the cross rebar to the left face of the structure.\n\n- **Right Cover**: The distance between the right end of the cross rebar to right face of the structure.\n\n- **Bottom Cover**: The distance between cross rebars from the bottom face of the structure.\n\n- **Top Cover**: The distance between cross rebars from the top face of the structure.\n\n- **Rear Cover**: Rear cover for slab reinforcement of cross rebars.\n\n- **Diameter**: Diameter of cross rebars\n\n- **Amount**: It contains count of cross rebars.\n\n- **Spacing**: It contains spacing between cross rebars.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md), [Reinforcement API](Reinforcement_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe Slab Reinforcement tool can be used from the [Python](Python.md) console by using the following function:\n\n### Create Slab reinforcement having Straight Rebars Reinforcement \n\nTo create Slab reinforcement having Straight Rebars Reinforcement shown in above figures you can use makeSlabReinforcement function as follows:\n\n \n```python\nfrom SlabReinforcement.SlabReinforcement import makeSlabReinforcement\nSlabReinforcementGroup = makeSlabReinforcement(\n parallel_rebar_type=\"StraightRebar\",\n parallel_front_cover=20,\n parallel_rear_cover=20,\n parallel_left_cover=10,\n parallel_right_cover=10,\n parallel_top_cover=30,\n parallel_bottom_cover=20,\n parallel_diameter=8,\n parallel_amount_spacing_check=False,\n parallel_amount_spacing_value=50,\n cross_rebar_type=\"StraightRebar\",\n cross_front_cover=20,\n cross_rear_cover=20,\n cross_left_cover=10,\n cross_right_cover=10,\n cross_top_cover=29,\n cross_bottom_cover=20,\n cross_diameter=8,\n cross_amount_spacing_check=False,\n cross_amount_spacing_value=50,\n mesh_cover_along = \"Bottom\",\n structure=App.getDocument(\"slab\").getObject(\"Beam\"),\n facename='Face4',\n)\n```\n\n- Creates a `SlabReinforcementGroup` object for Slab Spanning having Straight Rebars Reinforcement from the given `structure`, which is a Slab [Arch Structure](Arch_Structure.md), and `facename`, which is a face of that structure.\n - If no `structure` nor `facename` are given, it will take the user selected face as input.\n\n**Properties used for slab spanning in two direction for scripting**\n\n**Properties for Rebars in Parallel Direction to selected face:**\n\n- **parallel_rebar_type**: Type of rebar for parallel rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **parallel_front_cover**: The distance between parallel rebar and selected face.\n\n- **parallel_rear_cover**: Rear cover for slab reinforcement of parallel rebars.\n\n- **parallel_left_cover**: The distance between the left end of the parallel rebar to the left face of the structure.\n\n- **parallel_right_cover**: The distance between the right end of the parallel rebar to right face of the structure.\n\n- **parallel_top_cover**: The distance between parallel rebars from the top face of the structure.\n\n- **parallel_bottom_cover**: The distance between parallel rebars from the bottom face of the structure.\n\n- **parallel_diameter**: Diameter of parallel rebars.\n\n- **parallel_amount_spacing_check**: If is set to True, then value of parallel_amount_spacing_value is used as rebars count else parallel_amount_spacing_value\\'s value is used as spacing in parallel rebars.\n\n- **parallel_amount_spacing_value**: It contains count of rebars or spacing between parallel rebars based on value of amount_spacing_check.\n\n**Properties for Rebars in Cross Direction to selected face:**\n\n- **cross_rebar_type**: Type of rebar for cross rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **cross_front_cover**: The distance between cross rebar and cross_face (face perpendicular to selected face).\n\n- **cross_rear_cover**: Rear cover for slab reinforcement of cross rebars.\n\n- **cross_left_cover**: The distance between the left end of the cross rebar to the left face of the structure.\n\n- **cross_right_cover**: The distance between the right end of the rebar to right face of the structure relative to cross_face.\n\n- **cross_top_cover**: The distance between cross rebar from the top face of the structure.\n\n- **cross_bottom_cover**: The distance between cross rebar from the bottom face of the structure.\n\n- **cross_diameter**: Diameter of cross rebars.\n\n- **cross_amount_spacing_check**: If is set to True, then value of cross_amount_spacing_value is used as rebars count else cross_amount_spacing_value\\'s value is used as spacing in rebars.\n\n- **cross_amount_spacing_value**: It contains count of rebars or spacing between rebars based on value of cross_amount_spacing_check.\n\n**Common Properties for Parallel and Cross Rebars:**\n\n- **mesh_cover_along**: It can have two values \\\"Top\\\" and \\\"Bottom\\\". It represent alignment of rebar mesh along top or bottom face of structure.\n\n- **structure**: Arch structure object. Default is None\n\n- **facename**: selected face of structure. Default is None\n\n### Edition of Slab Reinforcement of Slab Spanning having Straight Rebars Reinforcement \n\nYou can change the properties of the Slab Reinforcement for Slab Spanning having Straight Rebars Reinforcement by using editSlabReinforcement function as follows:\n\n \n```python\nfrom SlabReinforcement.SlabReinforcement import editSlabReinforcement\nSlabReinforcementGroup = editSlabReinforcement(\n SlabReinforcementGroup,\n parallel_rebar_type=\"StraightRebar\",\n parallel_front_cover=20,\n parallel_rear_cover=20,\n parallel_left_cover=10,\n parallel_right_cover=10,\n parallel_top_cover=30,\n parallel_bottom_cover=20,\n parallel_diameter=8,\n parallel_amount_spacing_check=True,\n parallel_amount_spacing_value=10,\n cross_rebar_type=\"StraightRebar\",\n cross_front_cover=20,\n cross_rear_cover=20,\n cross_left_cover=10,\n cross_right_cover=10,\n cross_top_cover=20,\n cross_bottom_cover=20,\n cross_diameter=8,\n cross_amount_spacing_check=True,\n cross_amount_spacing_value=10,\n mesh_cover_along = \"Bottom\",\n structure=App.getDocument(\"slab\").getObject(\"Beam\"),\n facename='Face4',\n)\n```\n\n- `slabReinforcementGroup`is a previously created `Slab Reinforcement` group object.\n\n- The other parameters are the same as required by the `makeSingleTieFourRebars()` function.\n\nyou can change any property to edit Slab Reinforcement.\n\n\n---\n⏵ [documentation index](../README.md) > [External_Command_Reference](Category_External_Command_Reference.md) > [Reinforcement](Category_Reinforcement.md) > Example Slab Having Mesh Of Straight Rebars\n"} {"id": "freecad-docs:wiki/Example_Slab_Having_UShape_Rebars_Reinforcement_Mesh.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Example_Slab_Having_UShape_Rebars_Reinforcement_Mesh.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Example_Slab_Having_UShape_Rebars_Reinforcement_Mesh.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6b62415dafa2ae06d769d7dcabc1ea445028cfe7131e93d8c281fb9b1ea3b7b2", "bytes": 11878, "tokens": 3722, "text": "---\n TutorialInfo:\n Topic: Example Slab Having U-Shape Rebars Reinforcement Mesh\n Level: Intermediate\n Time: \n Author: Shiv Charan\n FCVersion: 0.20\n Files: \n---\n\n# Example Slab Having UShape Rebars Reinforcement Mesh\n\n \n\n\n## Description\n\nThe \"\" [Reinforcement SlabRebars](Reinforcement_SlabRebars.md) tool allows the user to create reinforcing bars inside a Slab [Arch Structure](Arch_Structure.md) object.\n\nThis tool is part of the \"\" [Reinforcement Workbench](Reinforcement_Workbench.md), an [external workbench](External_workbenches.md) that can be installed with the \"\" [Addon Manager](Std_AddonMgr.md).\n\nIn this example we will create Slab Reinforcement having U-Shape Rebars for both direction as shown in below figure.\n\n \"\" \n*A Example of Slab Reinforcement having U-Shape Rebars in Slab [Arch Structure](Arch_Structure.md)*\n\n## Usage\n\n1\\. Select any face of a previously created Slab ** [Arch Structure](Arch_Structure.md)** object. as shown in below image.\n\n\n: \"\"\n\n\n: \n \n*Selected face for Slab Arch Structure*\n \n\n2\\. Then select ** [Slab Reinforcement](Reinforcement_SlabRebars.md)** from the rebar tools.\n\n3\\. A dialog box will pop-out on screen as shown below.\n\n\n: ![](images/Slab_Reinforcement_input_dialog_box.png )\n\n\n: \n \n*Dialog Box for the Slab Reinforcement*\n \n\n4\\. Select the desired type of cover of reinforcement mesh (Top or Bottom) In example Bottom is selected.\n\n5\\. Select the UShapeRebar rebar type and other input data for radars in parallel direction of selected face as show in below image.\n\n\n: ![](images/U-shape_parallel_rebars_inputs.png )\n\n\n: \n \n*Dialog Box for Slab Reinforcement of the Rebars in parallel direction of selected face*\n \n\n6\\. Now click on **Next** button or select Cross Rebars in list view.\n\n7\\. Now select UShapeRebar rebar type and other desired data for input data for rebars in cross direction of selected face as show in below image.\n\n\n: ![](images/U-Shape_rebars_in_cross_direction_inputs.png )\n\n\n: \n \n*Dialog Box for Slab Reinforcement of the Rebars in cross direction of selected face*\n \n\n8\\. Click **OK** or **Apply** or **Finish** to generate Slab reinforcement.\n\n9\\. Click **Cancel** to exit the dialog box.\n\n## Properties Used for Slab Reinforcement Having U-Shape Rebars \n\n**Properties for Rebars in Parallel Direction to selected face:**\n\n- {{ PropertyData\\|Mesh Cover Along}}: It represent alignment of rebar mesh along top or bottom face of structure. It can have two values \\\"Top\\\" and \\\"Bottom\\\".\n- {{ PropertyData\\|Rebar Type}}: Type of rebar for parallel rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n- {{ PropertyData\\|Front Cover}}: The distance between parallel rebar and selected face.\n- {{ PropertyData\\|Left Cover}}: The distance between the left end of the parallel rebar to the left face of the structure.\n- {{ PropertyData\\|Right Cover}}: The distance between the right end of the parallel rebar to right face of the structure.\n- {{ PropertyData\\|Bottom Cover}}: The distance between parallel rebars from the bottom face of the structure.\n- {{ PropertyData\\|Top Cover}}: The distance between parallel rebars from the top face of the structure.\n- {{ PropertyData\\|Rear Cover}}: Rear cover for slab reinforcement of parallel rebars.\n- {{ PropertyData\\|Diameter}}: Diameter of parallel rebars.\n- {{ PropertyData\\|Rounding}}: A rounding value to be applied to the corners of the bars, expressed in times of diameter of parallel rebars.\n- {{ PropertyData\\|Amount}}: It contains count of parallel rebars.\n- {{ PropertyData\\|Spacing}}: It contains spacing between parallel rebars.\n\n**Properties for Rebars in Cross Direction to selected face:**\n\n- {{ PropertyData\\|Rebar Type}}: Type of rebar for cross rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n- {{ PropertyData\\|Front Cover}}: The distance between cross rebar and selected face.\n- {{ PropertyData\\|Left Cover}}: The distance between the left end of the cross rebar to the left face of the structure.\n- {{ PropertyData\\|Right Cover}}: The distance between the right end of the cross rebar to right face of the structure.\n- {{ PropertyData\\|Bottom Cover}}: The distance between cross rebars from the bottom face of the structure.\n- {{ PropertyData\\|Top Cover}}: The distance between cross rebars from the top face of the structure.\n- {{ PropertyData\\|Rear Cover}}: Rear cover for slab reinforcement of cross rebars.\n- {{ PropertyData\\|Rounding}}: A rounding value to be applied to the corners of the bars, expressed in times of diameter of cross rebars.\n- {{ PropertyData\\|Diameter}}: Diameter of cross rebars\n- {{ PropertyData\\|Amount}}: It contains count of cross rebars.\n- {{ PropertyData\\|Spacing}}: It contains spacing between cross rebars.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md), [Reinforcement API](Reinforcement_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe Slab Reinforcement tool can be used from the [Python](Python.md) console by using the following function:\n\n### Create Slab Reinforcement of U-Shape Rebars \n\nTo create Slab reinforcement U-Shape Rebars as shown in above figures you can use makeSlabReinforcement function as follows:\n\n \n```python\nfrom SlabReinforcement.SlabReinforcement import makeSlabReinforcement\nSlabReinforcementGroup = makeSlabReinforcement(\n parallel_rebar_type=\"UShapeRebar\",\n parallel_front_cover=20,\n parallel_rear_cover=20,\n parallel_left_cover=10,\n parallel_right_cover=10,\n parallel_top_cover=30,\n parallel_bottom_cover=20,\n parallel_rounding=2,\n parallel_diameter=8,\n parallel_amount_spacing_check=True,\n parallel_amount_spacing_value=12,\n cross_rebar_type=\"UShapeRebar\",\n cross_front_cover=20,\n cross_rear_cover=20,\n cross_left_cover=10,\n cross_right_cover=10,\n cross_top_cover=20,\n cross_bottom_cover=20,\n cross_rounding=2,\n cross_diameter=8,\n cross_amount_spacing_check=True,\n cross_amount_spacing_value=12,\n mesh_cover_along = \"Bottom\",\n structure=App.getDocument(\"slab\").getObject(\"Beam\"),\n facename='Face4',\n)\n```\n\n- Creates a `SlabReinforcementGroup` object for slab reinforcement having U-Shape rebars for the given `structure`, which is a Slab [Arch Structure](Arch_Structure.md), and `facename`, which is a face of that structure.\n - If no `structure` nor `facename` are given, it will take the user selected face as input.\n\n**Properties used for slab reinforcement having U-Shape rebars for scripting reinforcement**\n\n**Properties for Rebars in Parallel Direction to selected face:**\n\n- **parallel_rebar_type**: Type of rebar for parallel rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **parallel_front_cover**: The distance between parallel rebar and selected face.\n\n- **parallel_rear_cover**: Rear cover for slab reinforcement of parallel rebars.\n\n- **parallel_left_cover**: The distance between the left end of the parallel rebar to the left face of the structure.\n\n- **parallel_right_cover**: The distance between the right end of the parallel rebar to right face of the structure.\n\n- **parallel_top_cover**: The distance between parallel rebars from the top face of the structure.\n\n- **parallel_bottom_cover**: The distance between parallel rebars from the bottom face of the structure.\n\n- **parallel_diameter**: Diameter of parallel rebars.\n\n- **parallel_amount_spacing_check**: If is set to True, then value of parallel_amount_spacing_value is used as rebars count else parallel_amount_spacing_value\\'s value is used as spacing in parallel rebars.\n\n- **parallel_amount_spacing_value**: It contains count of rebars or spacing between parallel rebars based on value of amount_spacing_check.\n\n- **parallel_rounding**: A rounding value to be applied to the corners of the bars, expressed in times the parallel_diameter.\n\n**Properties for Rebars in Cross Direction to selected face:**\n\n- **cross_rebar_type**: Type of rebar for cross rebars for slab reinforcement. It can have four values \\'StraightRebar\\', \\'LShapeRebar\\', \\'UShapeRebar\\', \\'BentShapeRebar\\'.\n\n- **cross_front_cover**: The distance between cross rebar and cross_face (face perpendicular to selected face).\n\n- **cross_rear_cover**: Rear cover for slab reinforcement of cross rebars.\n\n- **cross_left_cover**: The distance between the left end of the cross rebar to the left face of the structure.\n\n- **cross_right_cover**: The distance between the right end of the rebar to right face of the structure relative to cross_face.\n\n- **cross_top_cover**: The distance between cross rebar from the top face of the structure.\n\n- **cross_bottom_cover**: The distance between cross rebar from the bottom face of the structure.\n\n- **cross_diameter**: Diameter of cross rebars.\n\n- **cross_amount_spacing_check**: If is set to True, then value of cross_amount_spacing_value is used as rebars count else cross_amount_spacing_value\\'s value is used as spacing in rebars.\n\n- **cross_amount_spacing_value**: It contains count of rebars or spacing between rebars based on value of cross_amount_spacing_check.\n\n- **cross_rounding**: A rounding value to be applied to the corners of the bars, expressed in times the cross_diameter.\n\n**Common Properties for Parallel and Cross Rebars:**\n\n- **mesh_cover_along**: It can have two values \\\"Top\\\" and \\\"Bottom\\\". It represent alignment of rebar mesh along top or bottom face of structure.\n\n- **structure**: Arch structure object. Default is None\n\n- **facename**: selected face of structure. Default is None\n\n### Edition of Slab Reinforcement having U-Shape Rebars \n\nYou can change the properties of the Slab Reinforcement having U-Shape Rebars by using editSlabReinforcement function as follows:\n\n \n```python\nfrom SlabReinforcement.SlabReinforcement import editSlabReinforcement\nSlabReinforcementGroup = editSlabReinforcement(\n SlabReinforcementGroup,\n parallel_rebar_type=\"UShapeRebar\",\n parallel_front_cover=20,\n parallel_rear_cover=20,\n parallel_left_cover=10,\n parallel_right_cover=10,\n parallel_top_cover=30,\n parallel_bottom_cover=20,\n parallel_rounding=2,\n parallel_diameter=8,\n parallel_amount_spacing_check=True,\n parallel_amount_spacing_value=15,\n cross_rebar_type=\"UShapeRebar\",\n cross_front_cover=20,\n cross_rear_cover=20,\n cross_left_cover=10,\n cross_right_cover=10,\n cross_top_cover=20,\n cross_bottom_cover=20,\n cross_rounding=2,\n cross_diameter=8,\n cross_amount_spacing_check=True,\n cross_amount_spacing_value=15,\n mesh_cover_along = \"Bottom\",\n structure=App.getDocument(\"slab\").getObject(\"Beam\"),\n facename='Face4',\n)\n```\n\n- `slabReinforcementGroup`is a previously created `Slab Reinforcement` group object.\n\n- The other parameters are the same as required by the `makeSingleTieFourRebars()` function.\n\nyou can change any property to edit Slab Reinforcement.\n\n\n---\n⏵ [documentation index](../README.md) > [External_Command_Reference](Category_External_Command_Reference.md) > [Reinforcement](Category_Reinforcement.md) > Example Slab Having UShape Rebars Reinforcement Mesh\n"} {"id": "freecad-docs:wiki/Extend_FEM_Module.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Extend_FEM_Module.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Extend_FEM_Module.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7cd9c812ece279292ca153bf78add2d1dcde89ff4a9681c88c6f555b9e9b73e3", "bytes": 7451, "tokens": 2114, "text": "---\n TutorialInfo:\n Topic: FEM\n Level: Intermediate\n Time: 1 hour\n Author: User:M42kus\n FCVersion: 0.17\n---\n\n# Extend FEM Module\n\n \n\n\nThe FEM workbench already supports a lot of different constraints and several solvers. Despite that users often need constraints not yet supported by FreeCAD. This page is the starting point to a series of tutorials and other resources describing how to extend the FEM workbench using the existing framework. While this series can prove helpful to software developers too the idea is to allow FEM users with a bit of interest into python coding to add the stuff they need themselves.\n\nAdding new constraints, equations or solver is mostly routine work. But doing it for the first time will not be as easy as it might seem. An understanding of the following topics will prove helpful:\n\n- Python scripting in FreeCAD.\n - [FreeCAD Scripting Tutorial](Python_scripting_tutorial.md)\n - [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md)\n- Extending FreeCAD with Python.\n - [Scripted Objects](Scripted_objects.md)\n- A solid understanding of the solver for which new objects shall be added (e.g. CalculiX or Elmer) is important.\n- A little knowledge about build systems, especially cmake (build system used by FreeCAD).\n\n## Build System (cmake) \n\nThe build system must be modified regardless of which objects shall be added o the FEM workbench. Every python module (file) must be registered. The FEM workbench requires every new python module to be registered in `Mod/Fem/CMakeLists.txt`. This is true regardless of the type of the python module (GUI or non-GUI). Where exactly the module must be inserted depends on the role of the module. Solver, equations and constraints all use different lists. Searching for similar files and inserting the new file in the same list works most of the time.\n\nAs an **example** lets add a new constraint called for this constraint. A new constraint requires at least the following new modules:\n\n- `constraint_.py`\n \n\n- `view_constraint_.py`\n \n\n- `CommandFemConstraint.py`(may be unnecessary)\n\nThese three files must be added to `Mod/Fem/CMakeLists.txt` as well as `Mod/Fem/App/CMakeLists.txt`. All inserted lines of code are indicated by a starting **+**.\n\n **Mod/Fem/CMakeLists.txt**\n\n\n{{code|code=\nSET(FemObjects_SRCS\n femobjects/__init__.py\n femobjects/base_fempythonobject.py\n femobjects/constraint_bodyheatsource.py\n femobjects/constraint_electrostaticpotential.py\n femobjects/constraint_flowvelocity.py\n femobjects/constraint_initialflowvelocity.py\n+ femobjects/constraint_initialflowpressure.py\n femobjects/constraint_selfweight.py\n...\n femobjects/solver_ccxtools.py\n)\n...\nSET(FemGuiViewProvider_SRCS\n femviewprovider/__init__.py\n femviewprovider/view_base_femconstraint.py\n femviewprovider/view_base_femobject.py\n femviewprovider/view_constraint_bodyheatsource.py\n femviewprovider/view_constraint_electrostaticpotential.py\n femviewprovider/view_constraint_flowvelocity.py\n+ femviewprovider/view_constraint_flowpressure.py\n femviewprovider/view_constraint_initialflowvelocity.py\n femviewprovider/view_constraint_selfweight.py\n...\n femviewprovider/view_solver_ccxtools.py\n)\n}}\n\n\n## Source Organization \n\nFor organizing the python code the FEM module uses the following approach. The module is split into the following packages:\n\n- `femobjects`, which contains all non-GUI like python proxies for document objects and\n\n- `femviewproviders`containing everything GUI related like python proxies for view provider\n\n- C++ based task panels are stored in \\'`Gui`\\',\n\n- icons can be found in \\'`Gui/Resources/icons/`\\',\n\n- .ui files are stored in \\'`Gui/Resources/ui/`\\' commands.\n\nOne package doesn\\'t follow this pattern: `femsolver`. It has its place on the same level as `femobjects` and `femguiobjects` (`src/Mod/Fem/femsolver`). The package contains solver and equation related packages and modules and it is organized the following way:\n\n\n .femsolver\n .femsolver.elmer\n .femsolver.elmer.equations\n .femsolver.calculix\n .femsolver.calculix.equations\n .femsolver.z88\n .femsolver.z88.equations\n\n\n## Solver\n\nIn FreeCAD a solver can be split into two parts:\n\n- One is the document object used by the user to interact with the solver. Through it, solver parameters can be set and it is also used to control the solving process.\n- The other one are the so called tasks of a solver. The solving process is split into those tasks, namely: *check, prepare, solve and results*. Those do the actual work of exporting the analysis into a format understood by the solver executable, starting the executable and loading the results back into FreeCAD.\n\nMost files related to a solver reside in a sub-package of the `femsolver` package (e.g. for Elmer its in `femsolver/elmer`). The following list enumerates all files related to the implementation of a solver. Those are the files that need to be copied and modified to add support for a new solver to FreeCAD. The given example is taken from the solver implementation of Elmer.\n\n- **femsolver/elmer/solver.py:** Document object visible in the tree-view. Implemented in python via a document proxy and view proxy.\n- **femsolver/elmer/tasks.py:** Module containing one task class per task required for a solver implementation. Those tasks divide the process of solving a analysis into the following steps: check, prepare, solve, results.\n- **femcommands/commands.py:** Adds the solver document object to the active document. Required to access the solver object from the GUI.\n\n## Equations\n\nAn equation represents a particular physics that shall be considered when solving the analysis (e.g. Flow, Heat). Not all solver in FreeCAD support (all) equations. Equations are represented by child objects of the corresponding solver object. In the tree-view this looks like this:\n\n- elmer-solver\n - elasticity\n - heat\n - flow\n - electrostatics\n\nMost solver specific options (e.g. max. iterations, method of solving, etc) are set via the equation objects. One consequence of this is that each solver must have it\\'s own implementation of \\\"the same\\\" equation. CalculiX would have a different Heat-object that Elmer. To avoid having multiple buttons for the same physics in the GUI each solver object adds it\\'s equations itself.\n\nThe actual implementation can be split into the generic and the solver specific part. The generic part can be found in the `femsolver.equationbase` module. The solver specific part resides inside individual Equations sub-packages of the solver packages (e.g. `femsolver/elmer/equations`).\n\nAdding a new equations to Elmer should be very easy. For newcomers there exists a tutorial which shows how to add a new equation to Elmer by adding the existing elasticity solver to FreeCAD: [Add FEM Equation Tutorial](Add_FEM_Equation_Tutorial.md).\n\n## Constraints\n\nConstraints define boundary conditions for the problem that shall be solved. In FreeCAD constraints aren\\'t specific to a particular solver. A problem setup can be solved by all solver that support all conditions in the analysis.\n\nAdding new constraints is quite straight forward. For newcomers there is a tutorial: [Add FEM Constraint Tutorial](Add_FEM_Constraint_Tutorial.md).\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > Extend FEM Module\n"} {"id": "freecad-docs:wiki/FCGear_InvoluteRack.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FCGear_InvoluteRack.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FCGear_InvoluteRack.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bd43f18c7f5477de2e90e21dbf7e411bdf2fe91e233a4f4f946d6a6071f8d362", "bytes": 5127, "tokens": 1700, "text": "---\n GuiCommand:\n Name: FCGear InvoluteRack\n MenuLocation: Gear , Involute Rack\n Workbenches: FCGear_Workbench\n Shortcut: None\n Version: v0.16\n SeeAlso: FCGear_InvoluteGear\n---\n\n# FCGear InvoluteRack\n\n## Description\n\nGear racks are used to convert a rotary motion into a linear motion or vice versa. The following examples show the different applications:\n\n- A rack with gear on at a retaining weir.\n- Various rack systems of rack-and-pinion railways.\n- Rack and pinion steering in a vehicle.\n- Rack and pinion winch as mechanical hoist (e.g. car jack).\n- Pneumatic rack and pinion drives used to control valves in pipeline transport.\n\n ![](images/Involute-Rack_example.png ) \n*From left to right: Spur gearing, helical gearing, double helical gearing*\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 **[ [Involute Rack](FCGear_InvoluteRack.md)** button in the toolbar.\n - Select the **Gear → [ Involute Rack** option from the menu.\n3. Change the gear parameter to the required conditions (see [Properties](#Properties.md)).\n\n## Properties\n\nAn FCGear InvoluteRack 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- **add_endings|Bool**: If {{True}} (default), then the total length of the rack is teeth \\* pitch. If {{False}}, then the rack starts with a tooth-flank.\n\n- **height|Length**: Default is {{Value|5 mm}}. Value of the gear width.\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- **teeth|Integer**: Default is {{Value|15}}. Number of teeth.\n\n- **thickness|Length**: Default is {{Value|5}}. Height from the tooth root to the lower side of the rod.\n\n\n{{Properties_Title|computed}}\n\n- **transverse_pitch|Length**: (read-only) Pitch in the transverse plane (see [Notes](#Notes.md)).\n\n\n{{Properties_Title|fillets}}\n\n- **head_fillet|Float**: Default is {{Value|0 mm}}.\n\n- **root_fillet|Float**: Default is {{Value|0 mm}}.\n\n\n{{Properties_Title|helical}}\n\n- **beta|Angle**: Default is {{Value|0 °}}. With the helix angle β a helical gear is created -- positive value → rotation direction right, negative value → rotation direction left.\n\n- **double_helix|Bool**: Default is {{False}}, {{True}} creates a double helix gear (see [Notes](#Notes.md)).\n\n- **properties_from_tool|Bool**: Default is {{False}}. If {{True}} and **beta** is not zero, gear parameters are recomputed internally for the rotated gear.\n\n\n{{Properties_Title|involute}}\n\n- **pressure_angle|Angle**: Default is {{Value|20 °}} (see [Notes](#Notes.md)).\n\n\n{{Properties_Title|precision}}\n\n- **simplified|Bool**: Default is {{False}}, {{True}} generates a simplified display (without teeth).\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- **transverse_pitch**: The value is the result of multiplication of **module * pi**. This means for the standard involute rack of FCGear: 15 (**teeth**) \\* 3.14 (**transverse_pitch**) is 47.12 mm. See also **module** further below.\n\n- **clearance**: At a gear pair, clearance is the distance between the tooth tip of the first gear and the tooth root of the second gear.\n\n- **double_helix**: To use the double helical gearing the helix angle β (**beta**) for the helical gearing must first be entered.\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. The result of the multiplication is displayed in **transverse_pitch**\n\n- **pressure_parameter**: Only change the parameter, if sufficient knowledge of the gear geometry is available.\n\n## Useful formulas \n\nSee [FCGear InvoluteGear](FCGear_InvoluteGear#Useful_formulas.md).\n\n## Scripting\n\nUse the power of python to automate your gear modeling: \n```python\nimport FreeCAD as App\nimport freecad.gears.commands\ngear = freecad.gears.commands.CreateInvoluteRack.create()\ngear.teeth = 20\ngear.beta = 20\ngear.height = 10\ngear.double_helix = True\nApp.ActiveDocument.recompute()\nGui.SendMsgToActiveView(\"ViewFit\")\n```\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 InvoluteRack\n"} {"id": "freecad-docs:wiki/FCMacro.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FCMacro.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FCMacro.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3c4b7ad096f0aae0600d53f1588ec0c09394fd8c16512436342403faefcbae0c", "bytes": 143, "tokens": 62, "text": "# FCMacro\n1. REDIRECT [Macros](Macros.md)\n\n\n---\n⏵ [documentation index](../README.md) > [File_Formats](Category_File_Formats.md) > FCMacro\n"} {"id": "freecad-docs:wiki/FEM_ConstraintElectrostaticPotential.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_ConstraintElectrostaticPotential.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_ConstraintElectrostaticPotential.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f15d8d9a62d39640343f04c0f6ecae0c7505eb81ad6b1d9427d571e771422034", "bytes": 2793, "tokens": 806, "text": "---\n GuiCommand:Container|\n{{GuiCommand\n Name: FEM ConstraintElectrostaticPotential\n MenuLocation: Model , Electromagnetic boundary conditions , Electrostatic potential boundary condition\n Workbenches: FEM_Workbench\n SeeAlso: FEM_Example_Capacitance_Two_Balls, FEM_tutorial\n}}\n{{GuiCommandFemInfo\n Solvers: Elmer\n}}\n---\n\n# FEM ConstraintElectrostaticPotential\n\n## Description\n\nCreates a FEM boundary condition for the electrostatic potential. To be used together with the [Electrostatic](FEM_EquationElectrostatic.md), [Electricforce](FEM_EquationElectricforce.md), [Magnetodynamic](FEM_EquationMagnetodynamic.md) or [Magnetodynamic2D](FEM_EquationMagnetodynamic2D.md) equation.\n\n## Usage\n\n1. Press the ** [Electrostatic potential boundary condition](FEM_ConstraintElectrostaticPotential.md)** button or use the menu **Model → Electromagnetic boundary conditions → Electrostatic potential boundary condition**.\n2. Press the **Add** button.\n3. In the [3D view](3D_view.md) select the object the boundary condition should be applied to.\n\n## Options\n\nThe dialog offers the following settings:\n\n![](images/FEM_ElectrostaticPotential_dialog.png )\n\n- **Potential**: The electric potential in V.\n- *unspecified*\\': To declare the potential as unknown for the solver.\n- **Vector Field**: To enable the input of the components of a potential vector field.\n- **x**: The real/imaginary part of the potential in x-direction in V. For other coordinate systems than Cartesian 3D, this will be the first coordinate of the system instead of x.\n- **y**: The real/imaginary part of the potential in y-direction in V. For other coordinate systems than Cartesian 3D, this will be the second coordinate of the system instead of y.\n- **z**: The real/imaginary part of the potential in z-direction in V. For other coordinate systems than Cartesian 3D, this will be the third coordinate of the system instead of z. If the coordinate system has no third coordinate, this setting will be ignored.\n- **x, y, z checkboxes**: To declare the corresponding potential as unknown for the solver.\n- **Potential Constant**: Option to set a constant potential.\n- **Farfield / Electric infinity**: Option to make spherical approximation that the volume above the face extends to infinity.\n- **Calculate Electric Force**: Option to trigger the calculation of the electric force using the [Electricforce](FEM_EquationElectricforce.md) equation.\n- **Capacity Body:**: Counter of the body (or face) with a capacitance.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM ConstraintElectrostaticPotential\n"} {"id": "freecad-docs:wiki/FEM_ConstraintForce.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_ConstraintForce.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_ConstraintForce.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a94dbdbd03560eb660287fd72a9535ab5e8e57f02919d1a1ae7c34ed593ccb20", "bytes": 2460, "tokens": 769, "text": "---\n GuiCommand:Container|\n{{GuiCommand\n Name: FEM ConstraintForce\n MenuLocation: Model , Mechanical boundary conditions and loads , Force load\n Workbenches: FEM_Workbench\n SeeAlso: FEM_ConstraintPressure\n}}\n{{GuiCommandFemInfo\n Solvers: All\n}}\n---\n\n# FEM ConstraintForce\n\n## Description\n\nApplies a force of a given value \\[N\\] to the selected geometry.\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Force load](FEM_ConstraintForce.md)** button\n - Select the **Model → Mechanical boundary conditions and loads → Force load** option from the menu.\n2. The Mesh object will be hidden automatically and reveal the original model. If the Mesh object is still visible, do one of the following to hide it:\n - Select the Mesh object in the [Tree view](Tree_view.md) and press **spacebar**.\n - Right-click on the Mesh object in the [Tree view](Tree_view.md) and select **Hide selection** from its context menu.\n3. The **Analysis feature parameters** dialog in the [Task panel](Task_panel.md) has also been opened.\n4. Press the **Add** button and select one or more of either *faces*, *edges* or *vertices* in the [3D view](3D_view.md) to apply the force to. The selected items will appear in the list of geometrical objects.\n5. Optionally press the **Remove** button and deselect one or more of the selected items in the [3D view](3D_view.md). The deselected items will be removed from the list of geometrical objects.\n6. Specify the **Force** value in \\[N\\].\n7. Optionally select a face or an edge and press the **Direction** button to change the force direction. In a typical case, you\\'ll leave this field empty to apply the force in the normal direction.\n8. Optionally check the **Reverse direction** checkbox to reverse the force direction.\n9. Click **OK** to finish.\n\n ![](images/FEM_ConstraintForce_example.JPG ) \n\n## Notes\n\n- The defined force is applied uniformly to the selected objects. For example, if you define one force load with 200 N applied to two faces having the same area, each face will be uniformly loaded with 100 N.\n- This feature uses the [\\*CLOAD card in CalculiX](https://web.mit.edu/calculix_v2.7/CalculiX/ccx_2.7/doc/ccx/node172.html).\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM ConstraintForce\n"} {"id": "freecad-docs:wiki/FEM_ConstraintPressure.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_ConstraintPressure.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_ConstraintPressure.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4c3a1d97a886b42568dff27459401d0d3fae1bbbec354a32153adb1541f90b62", "bytes": 1693, "tokens": 554, "text": "---\n GuiCommand:Container|\n{{GuiCommand\n Name: FEM ConstraintPressure\n MenuLocation: Model , Mechanical boundary conditions and loads , Pressure load\n Workbenches: FEM_Workbench\n SeeAlso: FEM_ConstraintForce\n}}\n{{GuiCommandFemInfo\n Solvers: CalculiX, Elmer\n}}\n---\n\n# FEM ConstraintPressure\n\n## Description\n\nApplies a pressure load to a face.\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Pressure load](FEM_ConstraintPressure.md)** button.\n - Select the **Model → Mechanical boundary conditions and loads → Pressure load** option from the menu.\n2. Press the **Add** button and select face(s) in the [3D view](3D_view.md). Optionally press the **Remove** and click on the faces that you want to remove from the selection.\n3. Edit the appropriate window to specify the pressure load in MPa.\n4. Tick the box to reverse the direction if necessary.\n\n## Notes\n\n- Distribution of the pressure on a face is always uniform and always perpendicular to the face.\n\n- {{VersionMinus|0.21}}: Pressure load can be applied to shells but only when [Gmsh](FEM_MeshGmshFromShape.md) is used for meshing and group meshing is set to true. It is hardcoded as true so the user doesn\\'t have to worry about that. However, due to a bug, pressure load may require remeshing to work on shells.\n\n- This feature uses the [\\*DLOAD card in CalculiX](https://web.mit.edu/calculix_v2.7/CalculiX/ccx_2.7/doc/ccx/node190.html).\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM ConstraintPressure\n"} {"id": "freecad-docs:wiki/FEM_ConstraintSelfWeight.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_ConstraintSelfWeight.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_ConstraintSelfWeight.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f7ee49f7ce34c7c15752368fb073875fd1dab55037f86dd0f65497416312a160", "bytes": 2319, "tokens": 778, "text": "---\n GuiCommand:Container|\n{{GuiCommand\n Name: FEM ConstraintSelfWeight\n MenuLocation: Model , Mechanical boundary conditions and loads , Gravity load\n Workbenches: FEM_Workbench\n SeeAlso: FEM_tutorial\n}}\n{{GuiCommandFemInfo\n Solvers: CalculiX, Elmer\n}}\n---\n\n# FEM ConstraintSelfWeight\n\n## Description\n\nDefines a gravity acceleration acting on the whole model in the prescribed direction.\n\n\n{{VersionMinus|0.21}}\n\n: The acceleration has a fixed value of 9.81 m/s\\^2.\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Gravity load](FEM_ConstraintSelfWeight.md)** button.\n - Select the **Model → Mechanical boundary conditions and loads → Gravity load** option from the menu.\n\n2. A ConstraintSelfWeight object is created.\n\n3. \n (v1.0) : Optionally change its **Gravity Acceleration** property.\n\n4. Optionally change its **Gravity Direction** property.\n\n## Scripting\n\nNew object:\n\n \n```python\nimport ObjectsFem\nObjectsFem.makeConstraintSelfWeight(name)\n```\n\nAdd object to the analysis named Analysis:\n\n \n```python\nApp.ActiveDocument.Analysis.Member = App.ActiveDocument.Analysis.Member + [(object)]\n```\n\nExample:\n\n \n```python\nimport ObjectsFem\nselfweight_obj = ObjectsFem.makeConstraintSelfWeight(\"MySelfWeightObject\")\nApp.ActiveDocument.Analysis.Member = App.ActiveDocument.Analysis.Member + [selfweight_obj]\n```\n\n## Solver CalculiX \n\n### Limitations\n\n- {{VersionMinus|0.21}}: You need to modify the .inp file to edit gravity acceleration.\n\n- Self-weight is applied to the element set Eall which includes the whole model.\n\n### Editing CalculiX input file \n\nThe acceleration constant can be manually edited after generating the CalculiX input file.\n\nExample of lines in the .inp file:\n\n \n```python\n*DLOAD\nEall,GRAV,9810,0.0,0.0,-1.0\n```\n\nwhere 9810 is a gravity acceleration magnitude in \\[mm/s\\^2\\], and 0,0,-1 is the direction vector. The value can be set as a multiple of standard gravity acceleration to simulate loading of e.g. 4g.\n\n## Solver Z88 \n\n- Currently, not implemented in the Z88 solver.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM ConstraintSelfWeight\n"} {"id": "freecad-docs:wiki/FEM_EquationElectricforce.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_EquationElectricforce.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_EquationElectricforce.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ebf574dc7a88c6fe85b8790732b6f2f87c3a4c60076c9680598e761bfc57924a", "bytes": 2886, "tokens": 848, "text": "---\n GuiCommand:\n Name: FEM EquationElectricforce\n MenuLocation: Solve , Electromagnetic Equations , Electricforce equation\n Workbenches: FEM_Workbench\n Version: 0.19\n SeeAlso: FEM_EquationElectrostatic\n---\n\n# FEM EquationElectricforce\n\n## Description\n\nThis equation describes the electrostatic force acting on a surface.\n\nFor info about the math of the equation, see the [Elmer models manual](http://www.elmerfem.org/blog/documentation/), section *Electrostatic force*.\n\n## Usage\n\n1. After adding an Elmer solver as described [here](FEM_SolverElmer#Equations.md), select it in the [tree view](Tree_view.md).\n2. Either use the toolbar button \"\" or the menu **Solve → Electromagnetic Equations → Electricforce equation**.\n3. Now either use the toolbar button \"\" or the menu **Solve → Electromagnetic Equations → [Electrostatic equation](FEM_EquationElectrostatic.md)**. This is important because the electricforce equation needs the potential field calculated by the Electrostatic equation.\n4. Change the [equation\\'s solver settings](#Solver_Settings.md) or the [general solver settings](FEM_SolverElmer_SolverSettings.md) if necessary.\n\nThe electricforce equation only calculates the force for faces with a \"\" [electrostatic potential boundary condition](FEM_ConstraintElectrostaticPotential.md) if the boundary condition\\'s option **Calculate Electric Force** is used.\n\n## Solver Settings \n\nFor the general solver settings, see the [Elmer solver settings](FEM_SolverElmer_SolverSettings.md).\n\nThe electricforce equation provides this special setting:\n\n- **Exec Solver**: By default the equation is only solved after a time step passed. This means it is first solved after the solution of other equations converged. When the setting is *Always* the equation is solved after every iteration within a time step. (For [steady-state](FEM_SolverElmer_SolverSettings#Type.md) simulations the whole simulation is one time step.)\n\n## Analysis Feature Information \n\nThe electricforce equation does not have its own analysis features. It takes the \"\" [electrostatic potential boundary condition](FEM_ConstraintElectrostaticPotential.md) from the \"\" [Electrostatic equation](FEM_EquationElectrostatic.md). In the boundary condition it is important to use the option **Calculate Electric Force**.\n\n## Result\n\nThe result is the electric force density in $\\rm N/m^2$.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM EquationElectricforce\n"} {"id": "freecad-docs:wiki/FEM_PostCreateFunctionCylinder.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_PostCreateFunctionCylinder.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_PostCreateFunctionCylinder.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "51eb7a2eb74c19f3a41fd3d3df1b1d677f6fb7524b25df75752f7d608770ff67", "bytes": 2484, "tokens": 800, "text": "---\n GuiCommand:\n Name: FEM PostCreateFunctionCylinder\n MenuLocation: Results , Filter functions , Cylinder\n Workbenches: FEM_Workbench\n Version: 0.21\n SeeAlso: FEM_tutorial\n---\n\n# FEM PostCreateFunctionCylinder\n\n## Description\n\nThe \"\" **FEM PostCreateFunctionCylinder** function defines how a mesh is cut geometrically. It is used by \"\" [Function cut filter](FEM_PostFilterCutFunction.md) and \"\" [Region clip filter](FEM_PostFilterClipRegion.md).\n\n## Usage\n\n### Create a cylinder function \n\n1. Press the ** [Cylinder](FEM_PostCreateFunctionCylinder.md)** button or select the **Results → Filter functions → Cylinder** option from the menu.\n2. The Implicit function [task panel](Task_panel.md) is opened.\n3. Optionally set the values for the center and the radius of the section cylinder.\n4. Press the **OK** button to finish.\n\n### Edit a cylinder function \n\nIf the Cylinder object in the [tree view](Tree_view.md) is hidden, select the \"\" Cylinder object in the [3D view](3D_view.md) and press **Space** to make it visible, like in this example:\n\n \"\" \n\n#### Move the cylinder \n\n- Click and drag the big white cuboid to move the cylinder along its normal vector.\n- Click and drag the white grid.\n\n#### Rotate and tilt the cylinder \n\n- Click and drag a line that connects the small cubes with the big white cuboid to rotate and tilt the cylinder around its origin.\n\n#### Scale the cylinder \n\n- Click and drag one of the 6 small cubes to scale the cylinder.\n\n## Notes\n\n- Existing functions can be used for different filters and even for different \"\" [result pipelines](FEM_PostPipelineFromResult.md). It is nevertheless recommended to use a separate set of functions for each pipeline to keep track of the elements in the [tree view](Tree_view.md).\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM PostCreateFunctionCylinder\n"} {"id": "freecad-docs:wiki/FEM_PostFilterWarp.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FEM_PostFilterWarp.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FEM_PostFilterWarp.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a9ba08b5de50f77c0e42e16f559b3c321005434df12ffdfa344f094f4ecd4b05", "bytes": 1767, "tokens": 542, "text": "---\n GuiCommand:\n Name: FEM PostFilterWarp\n MenuLocation: Results , Warp filter\n Workbenches: FEM_Workbench\n SeeAlso: FEM_PostPipelineFromResult, FEM_tutorial\n---\n\n# FEM PostFilterWarp\n\n## Description\n\nDisplays the deformed shape of the model using a specified scale factor. Therefore a warp filter only has an effect for result vectors that deform the shape.\n\nThe result will be the same like with the *Displacement* slider of the [result show](FEM_ResultShow.md) dialog with the difference that the displacement is for the Warp filter in the SI unit meter. For example if you use a [unit system](Preferences_Editor#Units.md) where the length unit is mm and set a displacement factor of 100 in the [result show](FEM_ResultShow.md) dialog, you need to set for the Warp filter a factor of 100.000 to get the same result.\n\n ![](images/FEM_Warp-Filter-Example.gif ) \n\n*A warp filter of the displacement of a beam clamped on one side.*\n\n## Usage\n\n1. Select a previously created [result pipeline](FEM_PostPipelineFromResult.md).\n2. Invoke the command either by:\n - Pressing the button ** '''Warp filter'''** button.\n - Using the menu **Results → Warp filter**.\n3. Adjust the **Result display options** like for the [result pipeline](FEM_PostPipelineFromResult.md). Hide that pipeline to see the effect of a Warp Filter.\n4. Specify the **Warp factor** directly or use the slider to set it. The **Min warp** and **Max warp** fields allow you to adjust the range of the slider.\n5. Click the **OK** button to finish the command.\n\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > FEM PostFilterWarp\n"} {"id": "freecad-docs:wiki/Fastener_holes.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Fastener_holes.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Fastener_holes.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e2bb17778ad6e08c0053cce5652559bede011d97a3aed99d65b413cec21f8f0a", "bytes": 980, "tokens": 348, "text": "# Fastener holes\nThis macro creates shapes to act as holes when cut to other shapes. It makes easy and fast the creation and tweaking of all needed parts. It may be very useful when designing parts for 3D printing and others.\n\nIt recognizes the preselection (faces, edges or points) and place the hole in the center of it.\n\nExamples:\n\n\"\"\n\n\"\"\n\n\"\"\n\nFinally, using [Fasteners workbench](https://www.freecadweb.org/wiki/Fasteners_Workbench) you can easily add the fasteners themselves:\n\n\"\"\n\n## GitHub download \n\n[](https://github.com/pgilfernandez/FreeCAD_Fastener_holes)\n\n\n---\n⏵ [documentation index](../README.md) > [Macros](Category_Macros.md) > Fastener holes\n"} {"id": "freecad-docs:wiki/Fasteners_MatchTypeOuter.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Fasteners_MatchTypeOuter.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Fasteners_MatchTypeOuter.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0917a815a66efee5fe3d7a9ed79a9fc398606f096317725a6b66cf733cee5940", "bytes": 1289, "tokens": 437, "text": "---\n GuiCommand:\n Name: Fasteners MatchTypeOuter\n MenuLocation: Fasteners , Match for pass hole\n Workbenches: Fasteners_Workbench\n SeeAlso: Fasteners_MatchTypeInner\n---\n\n# Fasteners MatchTypeOuter\n\n## Description\n\nThe \"\" **Fasteners MatchTypeOuter** command behaves as a toggle with the [Fasteners MatchTypeInner](Fasteners_MatchTypeInner.md) command. When **Fasteners MatchTypeOuter** is selected, circular edges are considered to be pass holes when new fasteners are attached to them. This determines the default dimensions of those fasteners. This setting is not used for countersunk screws.\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Match for pass hole](Fasteners_MatchTypeOuter.md)** button.\n - Select the **Fasteners → Match for pass hole** option from the menu.\n2. The button stays depressed to indicate the selected option.\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 MatchTypeOuter\n"} {"id": "freecad-docs:wiki/Fasteners_Move.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Fasteners_Move.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Fasteners_Move.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9736ec2b25713fbe1123b81bae3f75d6642337ecc42b5931f2cc4fc7e1b9d7a6", "bytes": 1728, "tokens": 600, "text": "---\n GuiCommand:\n Name: Fasteners Move\n MenuLocation: Fasteners , Move fastener\n Workbenches: Fasteners_Workbench\n---\n\n# Fasteners Move\n\n## Description\n\nThe \"\" **Fasteners Move** command moves and attaches a fastener to a circular edge. It can also be used to detach a fastener. An attached fastener has a **Base Object** and its **Placement** is dynamically linked to that object.\n\n## Usage\n\n### Attach\n\n \"\" \"\" \n*On the left a fastener and a circular edge are selected. On the right the fastener has been moved and attached to the selected edge.*\n\n1. Select a single fastener and a single circular edge.\n2. There are several ways to invoke the command:\n - Press the ** [Move fastener](Fasteners_Move.md)** button.\n - Select the **Fasteners → Move fastener** option from the menu.\n3. The fastener moves to the selected edge and is attached to it.\n\n### Detach\n\n1. Select a single fastener.\n2. There are several ways to invoke the command:\n - Press the ** [Move fastener](Fasteners_Move.md)** button.\n - Select the **Fasteners → Move fastener** option from the menu.\n3. The fastener is detached.\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 Move\n"} {"id": "freecad-docs:wiki/Flamingo_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Flamingo_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Flamingo_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c18a8cf7c9c5501b42f0eaefe59711cbe3f138b0ccdd457cd728ab9ccb5a8cd3", "bytes": 30315, "tokens": 8325, "text": "# Flamingo Workbench\n**Flamingo Workbench (Python2/Qt4) has been superseded by the Dodo Workbench (Python3/Qt5). This wiki page will highlight the differences between these two workbenches. Currently [Dodo Workbench](Dodo_Workbench.md) links here.**\n\n## Introduction\n\nThis is a set of customized FreeCAD commands and objects that help to speed-up the drawing of frames and pipelines, mainly.\n\n\n: \\\"*Flamingo*\\\" workbench is dedicated for versions using Python \\>2.7 syntax and Qt4 toolkit.\n\n\n: \\\"*Dodo*\\\" workbench is for Python \\>3.6 and Qt5.\n\n\nFor convenience Flamingo/Dodo tools are grouped in three toolbars/menus + one utility set.\n\n![](images/flamingoBlob.png )\n\n![](images/dodoBlob.png )\n\n - **Frame tools**: that is aimed to arrange frames, trusses and similar in FreeCAD using the Structure objects of Arch module. \\.../flamingo/tutorials/tutorialFrame.pdf\n\n - **Pype tools**: that\\'s the logical continuation of frame tool since it deals with creating pipelines and tubular structures. It also features its own Python classes to create the piping objects, such as tubes, elbows, flanges etc. \\.../flamingo/tutorials/tutorialPype2.pdf\n\n - **Eagle tools**: that\\'s basically an addition, and shortcut, to the very professional [FreeCAD-PCB](https://github.com/marmni/FreeCAD-PCB) workbench (also available in the FreeCAD\\'s add-on repository) to import position of objects from a .brd Eagle\\'s file on a PCB drawn in FreeCAD with the a.m. workbench relating only on their names. It\\'s also the origin, by extension, of the name of the entire workbench. \\.../flamingo/tutorials/tutorialEagle.pdf\n\n - **Utils** toolbar provides some functionality to query the objects in the model and their distance, to move/rotate the work plane and a little hack of the [Draft Wire](Draft_Wire.md) creation dialog, which allow to change the work plane position on-the-fly.\n\n## References\n\n- Author: oddtopus\n- Source code on github:\n\n\n\n\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## Frame Tools \n\n\n
\n\n![](images/Flamingos_frame2.jpg )\n\n\n
\n\n\n: 1\\) Place one-beam over one-edge (class frameIt)\n\nGiven a beam object and an edge in the model, this tool lay down the beam over the edge by selecting them one after the other until ESC is pressed.\n\n: 2\\) Fill the frame (class fillFrame)\n\nDialog to create over multiple edges selected in the viewport the beams of the type of that previously chosen among those present in the model.\n\nWith the button **Select** it\\'s possible to change the type of beam.\n\n\n**Dodo: this function has been replaced within the \"Insert framebranch\" dialog with the \"Add single\" pushbutton**\n\n\n: 3\\) Insert a path (class insertPath)\n\nTool to create a continuous DWire over the path defined by the edges selected in the viewport, even if these are not touching or are intersecting in the middle or belongs to different objects. The only constraint is that exists the intersection between two subsequent edges, in the order that they were selected. Also the DWire is given the view-properties of a center-line, i.e. orange and dash-dotted.\n\n: 4\\) Insert Std. Sections (class insertSection)\n\nDialog to create the set of profiles to be used in the model for object FrameLine.\n\n- **Section** list: it includes all the sections defined in the .csv file corresponding to the selected section type.\n- **Section types** list: the types of profiles defined with the .csv files included in the folder /tables\n- **Insert** button: creates the group \\\"Profiles_set\\\", if not already existing, and adds to it the object of the selected profile.\n\nOther profiles tables can be created by adding the relevant .csv file in the /tables folder. The rules to create or customize such tables are similar to those for pipe-lines.\n\nOther profiles can be drafted in the model and dragged inside the group \\\"Profiles_set\\\".\n\nThe orientation of the DWires may influence the rendering of beams.\n\n\n**Dodo: changed the scope of this function.\nIn dodo this opens a dialog from which it's possible to create 10 shapes for beam's section with customized dimensions:\n* hollow and full square\n* hollow and full circle\n* T, I, C, L, Z\n* omega\nIt's also possible to change the position of center or edit an existing section.**\n\n\n: 5\\) FrameLine manager (class FrameLineManager)\n\nSame as for \\\"pype-line\\\" objects, this is a dialog to create and change properties of \\\"frame-line\\\" objects.\n\nAlso similarly to what seen above, the frame-lines are objects that collects properties common to a set of beams (namely the beam\\'s section) which are included in a common group in the tree of the model. They also have an optional property \\\".Base\\\", by default set to None, which is the centerline of the beams of the frame. After a path, alias .Base, is defined (a DWire or a Sketch) other beams can be added to the frame-line but they will be deleted when **Redraw** is invoked. The dialog provides the following features:\n\n- a list of beams\\' profiles previously included in the model by \\\"Insert Std. Sections\\\" dialog (read further);\n- a combo-box to select the active FrameLine among those already created or to create a new one;\n- a text-box where to write the name of the FrameLine that is going to be created; if nothing or \\\"\\\", the FrameLined will be named as default \\\"Telaio00n\\\";\n- **Insert** button: creates a new FrameLine object or adds new members to the one selected in the combo-box if edges are selected in the active viewport.\n- **Redraw** button: creates new beams and places them over the selected path. New beams will be collected inside the group of the FrameLine. Does not create or update beams added to the FrameLine outside its defined path.\n- **Clear** button: deletes all beams in the FrameLine group. It applies also to beams added to the FrameLine outside its defined path.\n- **Get Path** button: assigns the Dwire selected to the attribute Path of the FrameLine object.\n- **Get Profile** button: changes the Profile attribute of the FrameLine object to the one of the beam selected in the viewport or the one selected in the list.\n- **Copy profile** checkbox: if checked generates a new profile object for each beam in order to avoid multiple references in the model.\n- **Move to origin** checkbox: if checked, moves the center-of-mass of the profile to the origin of coordinates system: that makes the centerline of the beam coincide with the c.o.m. of the profile.\n\nIf the name of a FrameLine object is modified, also the name of the relevant group will change automatically but not viceversa\n\n: 6\\) FrameBranch manager\n\nSimilar to the analogous feature in the Pype menu, this is a container for beams structured on a .Base. The base can be a DWire, a Sketch or also the edges of a solid shape. When the underlying base is changed, also the position and length of the beams is modified accordingly. It\\'s possible to trim/extend to any geometry the beams and rotate the sections aroud the center-line through the commands provided in the dialog: in this way the modification is not lost when the document is recomputed.\n\n- **OK** creates one framebranch over the pre-selected geometry\n- **Cancel** closes the dialog\n- the **** text box allow to insert a custom name to the feature\n- the **combo box** allow to select the type of section that will be displayed in the **list box**. (see ../Mod/flamingo/shapes or ../Mod/dodo/shapez to customize)\n- **AddBeams** adds one member to a frame to the currently selected edge. The edge must belong to an existing framebranch\n- **RemoveBeams** removes the selected beam from the corresponding edge\n- **ChangeProfile** change the profiles to the framebranch. To select the framebranch just select in the view area one of its members.\n- **Get targets** selects geometry from the view area to trim/extend to the beams. Targets can also not belong to any framebranch.\n- **Trim/Extend** changes the lenght of selected members to the targets\n- **Add single** creates one beam, of the specified ****, not linked to the base on any edge or surface selected.\n- **Redraw** recreates the frame, deleting all the offsets and rotations\n\nWhen one beam belonging to a framebranch is selected in the view area, the TAIL is visually highlighted. That allows to change manually the offsets of tail and head, beside the rotation of the section, using the commands provided in the dialog.\n\n: 7\\) Spin beams by 45 deg. (class spinSect)\n\nTool to spin one object around the \\\"Z\\\" axis of its shape by 45 degrees.\n\n: 8\\) Reverse orientation (class reverseBeam)\n\nTool to spin one object around the \\\"X\\\" axis of its shape by 180 degrees. Notes: if one edge of the object is selected, that is used as the pivot of rotation.\n\n: 9\\) Shift the beam (class shiftBeam)\n\nDialog to translate and copy objects.\n\n**X**, **Y** and **Z** textboxes for direct input the amount of translation in each direction.\n\n**Multiple** textbox is the multiple coefficient of the translation amount.\n\n**Steps** textbox is the denominator of the translation amount. It\\'s used when the amount of translation is to be covered in some steps.\n\n**Get displacement** button to take the amount and direction of translation from the distance of selected entities (points, edges, faces) or even from a single edge. In the latter case, a green arrow is displayed to show the direction.\n\n**OK** to perform the action and **Cancel** to close the dialog.\n\n: 13\\) Rotate + mate the edges (class rotJoin)\n\nTool to translate and rotate the beams to mate two edges. Same as above but it also makes the edges co-linear.\n\n: 10\\) pivotTheBeam (class pivotBeam)\n\nDialog to rotate one beam or other object around one of its edges.\n\n**Angle** textbox to insert the degree of rotation.\n\n**Reverse** button to rotate in the opposite direction, if necessary.\n\n**OK** to perform the action and **Cancel** to close the dialog.\n\n: 11\\) Flush the surfaces (class levelBeam)\n\nTool to flush the parallel faces of two objects. Actually the command takes to the same level, respect the position and orientation of the first face selected, the center-of-mass of all faces selected. Thus it translates the objects even if the faces are not parallel.\n\n: 12\\) Mate the Edges (class alignEdge)\n\nTool to mate two parallel edges. Actually the command moves the objects along the minimum distance of their selected edge to the first one. Thus it translates the object even if edges are not parallel and it\\'s a good way to place objects in desired position. It is also possible to select two edges of the same objects. With this method is possible to move quickly one object by steps defined on its own geometry.\n\n: 14\\) alignFlange (class alignFlange)\n\nDialog to rotate beams so that their surfaces are parallel to one reference plane.\n\nIt\\'s possible to preselect the reference face before invoking the command.\n\nThe three **XY**, **XZ** and **YZ** buttons allow to choose directly the orientation of principal planes as the reference.\n\nFinally it\\'s possible to enter directly the new orientation of faces by the three coordinates of the normal and the button **Set normal**.\n\n: 15\\) Stretch the beam (class stretchBeam)\n\nDialog to change the length of beams.\n\nIn the textbox write the new length that will be applied to selected beams or pipes. Otherwise **Get Length** button takes the new length from the selected geometry (either the length of a beam or edge or the distance between geometric entities).\n\nWith the slider it\\'s possible to change the length wirtten in the text-box from -100% to +100%.\n\nRadio buttons **Head** and **Tail** allow to choose the side of the beam that will be changed.\n\n: 16\\) Extend the beam (class extend)\n\nDialog to extend one beam to one selected target.\n\nIf entities are preselected before calling this command, the first entity is automatically taken as target and the object attached to it is removed from the selection set. In any case it\\'s possible to change the target object with the push-button **Select**.\n\n: 17\\) Adjust frames\\' angle (class adjustFrameAngle)\n\nTool to adjust the beams at square angles of frames. To understand at best how it works, refer to the previous tutorial.\n\n## Pype Tools \n\n\n
\n\n![](images/Flamingos_pype2.jpg )\n\n\n
\n\n\n: 1\\) Insert a tube\n\nOpens a dialog to insert tubes.\n\nThe top-right combo is a common feature for all \\\"Insert \\...\\\" dialogs: it lists the pype-line objects defined in the current document: with this it\\'s possible to select to which pype-line to assign the newly created pipes. You can also leave it to so that the object is created on the root line of the part model. In the top-left corner is printed the currently selected pipe rating, taken from the listbox in the right column. Pipes dimensions for each pipe-rating are defined in .csv files, which is possible to add or modify, with few simple naming rules, according needs. Curves, reductions etc. have the same rules for definition of their tables of dimensions: see files in ../Mod/flamingo/Tables. Read also \\\"tutorialPype.pdf\\\" to know how to customize or create them.\n\nTo define position and orientation of pipes, following selections are possible:\n\n- one or more straight edges\n- one or more curved edges\n- one or more vertexes\n- nothing; in this case the tube will be placed at origin.\n\nIf no length is specified, the default is 200 units (just a convenient length, in mm).\n\n**Reverse** button allow to rotate by 180° the last tube created or those currently selected.\n\n**Apply** button allow to apply a different lenght or Nominal diameter to the tubes currently selected.\n\n\n**Dodo: added a pie-menu (keyboard shortcut: \"Z\") to create \"pype\" objects: this is intended to insert faster refinements to the drawing**\n\n\n: 2\\) Insert a curve\n\nOpens a dialog to insert one elbow.\n\nBeside the common widgets with other \\\"Insert\\...\\\" dialogs, the **Trim/Extend** button allow to adjust the length of selected pipes to the selected edge of the curve. To define position and orientation following selections are possible:\n\n- one vertex,\n- one circular edge\n- one pipe at one of its ends; in this case the curve\\'s diameter and thickness will automatically fit those of the selected pipe\n- a pair of edges or pipes or beams, also not contiguous but intersecting; in this case curve\\'s properties will automatically fit to connect the two selected objects; also selected pipes will be automatically trimmed or extended to the curve\\'s edges\n- nothing; in this case the curve will be placed at origin.\n\nIf no angle is specified the default is 90 degrees.\n\n: 3\\) Insert a reduction\n\nOpens a dialog to insert concentric reductions.\n\nTo define position and orientation following selections are possible: two pipes parallel (possibly co-linear)\n\n- one pipe at one of its ends\n- one pipe\n- one circular edge\n- one straight edge\n- one vertex\n- nothing (created at origin)\n\nIn case one pipe is selected, its properties are applied to the reduction.\n\nIn case two pipes are selected, the tool will try automatically to connect them with the right major and minor diameter.\n\n: 4\\) Insert a cap\n\nOpens dialog to insert caps.\n\nTo define position and orientation following selections are possible: one or more curved edges (axis and origin across the center) one or more vertexes nothing If a pipe edge is selected the caps\\' properties will automatically fit to those of the pipe.\n\n: 5\\) Insert a valve\n\nCreate a \\\"placeholder\\\" of a valve from a .csv table like above. Beside the offset dimension, it\\'s important because it defines also the Kv coefficient that will be used to calculate pressure losses with the relevant tool in \\\"Utils\\\" menu. Note that the symbol of the placeholder changes according the type of the valve, if in its name is found one keyword among \\\"ball\\\", \\\"butterfly\\\" or \\\"globe\\\".\n\n: 6\\) Insert a flange\n\nOpens dialog to insert flanges. To define position and orientation following selections are possible:\n\n- one or more circular edges,\n- one or more vertexes,\n- nothing.\n\nIn case one pipe is selected, its properties are applied to the flange.\n\n: 7\\) Insert a U-bolt\n\nOpens dialog to insert U-bolts.\n\nTo define position and orientation following selections are possible:\n\n- one or more circular edges\n- one or more pipes\n- nothing.\n\nIn case one pipe is selected, its properties are aplied to the U-bolt. Moreover it\\'s possible to choose to place the U-bolt at the **Head** or **Tail** ends or in the **Middle** of the pipes by checking the relevant box.\n\nWith **Ref. face** button it\\'s possible to select the face of the support to which to orient the U-bolt axis.\n\n\n*Only in **dodo**: the above piping components can be inserted also wfrom the dedicated pie-menu.*\n\n\n: 8\\) PypeLine Manager\n\nBefore talking about the dialog it\\'s worth to recall what the pype-line object is in the context of Flamingo workbench.\n\nThis object represent a collection of objects \\\"PType\\\" that are updated with the methods defined in the Python class itself. At present time it creates, with the method \\\"obj.Proxy.update(obj,\\[edges\\])\\\", pipes and curves over the given edges and collect them in a group named according the object\\'s obj.Label. A standard bending radius \\\"3D\\\" (i.e. 1.5xO.D.) is applied for curves. The Bend Radius is a common property of object pype-line, thus it can be changed and then redrawn. When the Label of the object pype-line is renamed, the name of its group is changed accordingly.\n\nThe class PypeLine2 has also the optional attribute \\\".Base\\\", which namely represent the centerline of the piping:\n\n- If Base is None, PypeLine2 behaves like a bare container of objects, with possibility to group them automatically, assign one color and extract the part-list.\n- .Base can be a Wire or a Sketch or any object which has edges in its Shape.\n- Running \\\"obj.Proxy.update(obj)\\\", without any \\[edges\\], the class attempts to render the pypeline (Pipe and Elbow objects) on the \\\"obj.Base\\\" edges: for well defined geometries this usually leads to the desired result. If \\[edges\\] are given, pipes and curves will be drawn along them.\n- Running \\\"obj.Proxy.purge(obj)\\\" deletes from the model all Pipes and Elbows that belongs to the pype-line.\n- Remember that the object created outside the .Base won\\'t be updated when the .Base is changed and the pypeline is redrawn and (except pipe and curves) won\\'t be deleted if the pype-line is purged.\n\nThis understood, the command opens the dialog to create or modify one pype-line.\n\nThe dialog is very similar to those for insert other objects seen before.\n\nThe pipe ratings tables, where the O.D. and thickness are defined, are the same of those for tubes (e.g. Pipe_SCH-STD.csv).\n\nWhen is in the combo and **Insert** is pressed, a new pype-line object is created in the document with the relevant group.\n\nIt is possible to create one pypeline in three ways, according to the objects selected in the viewport when Insert is pushed:\n\n- nothing is selected. One pype-line is created with property .Base = None and included in its group with the specified name and color (or default values). The piping objects to populate it can be created one-by-one with the commands seen above or alternatively a centerline can be selected afterwards with **Get Profile** and **Redraw** buttons.\n- one DWire object is selected. It is automatically taken as Base and converted in a Path (orange, dash-dotted) and pipes and curves are drawn along it.\n- a set of edges are selected (even not contiguous but anyway having intersections extending their ends). One Path is created connecting all the edges (see the Path tool in the Frame toolbar) and assigned as .Base to the newly created pype-line. Then pipes and curves are drawn on it as above.\n\nAfter that it\\'s still possible to add other objects (such as Flange, Reduct\\...) using the relevant insertion commands described above. When objects are created within a pype-line they are automatically included in the relevant group of the model and the common properties (i.e. O.D., thickness, color, bending radius etc.) are applied.\n\nIf at least one pype-line is already in the model, that can be selected from the combo-box: in this case, pushing Insert creates the pipes and curves like described above but, instead of creating a new pype-line object, it adds them to the selected existing pype-line. Beware that the piping created in this way will be deleted at next **Redraw**.\n\n**Get Path**, Get Profile and Color allow to change the .Base property, the nominal size and color of the object respectively.\n\n**Redraw** re-create tubes and curves along the .Base (if defined) after any modification to the path or the properties of the pype-line.\n\n**Part list** generates a .csv file with the bill of material of the piping object included in the pype-line selected in the combo.\n\n: 9\\) Insert a PypeBranch\n\nThis pype object behave like a PypeLine except it automatically updates whenever the Base (a DWire or a SketchObject) is modified: that includes changing the placement, stretching, moving, adding or deleting edges. It is mainly intended to represent the secondary branches of the PypeLine (see the dedicated tutorial) but it can also act as a stand-alone object. This is an important task that allow to change quickly the layout of pipes but, as a drawback, its geometry is more rigidly defined. In other words, pipes can not be splitted or resized independently because they will be eventually redrawn on the Base. Changin the OD, thk or BendRadius of the PypeBranch, instead, will apply on all tubes and curves of it.\n\n: 10\\) Insert a tank\n\n[See tutorial Part 4 (1/2)](#Links.md)\n\n: 11\\) Insert a piperoute\n\n[See tutorial Part 4 (2/2)](#Links.md)\n\n: 12\\) Break the pipe\n\nOpens a dialog to break one pipe at a defined point, optionally making a gap between the ends of the two parts. Multiple selection is possible.\n\nInsert in the **Point** text-box the length where the pipe or pipes are going to break: this can be an absolute value or just a percentage of the length (a numeral followed by %). In some case it\\'s quicker to use the slide-bar at the bottom to change this value.\n\nThe **Length** button allow to measure the length of the selected pipe and use that as the reference of the slide-bar scale.\n\nIf it\\'s needed just to break pipes in two, leave the **Gap** text-box to 0; otherwise define the length of the gap. If a reference length is choosen, also the gap can be defined as a percentage. As seen in the [tutorial](https://github.com/oddtopus/flamingo/blob/master/tutorials), it\\'s possible to measure the gap from geometries in the model with the **Get gap** button: that\\'s the distance between any geometric entity or even the length of a single edge.\n\nPushing on **Break** performs the action.\n\nThe Pypeline combo, as usual, allow to choose the group to which to assign the new objects created.\n\n: 13\\) Mate pipes edges.\n\nWhen two circular edges belonging to different objects are selected, pressing this button will make the second object move to make the edges concentric and coplanar.\n\nThis works not only with pipes.\n\n: 14\\) Join the pypes\n\nJoins the Ports of different objects in a graphical way. It works only among pype-objects, also from different workbenches, where the Ports\\[\\] property is defined congruently.\n\n: 15\\) Fit one elbow\n\nSelect 2 intersecting pipes + 1 elbow: executing this command, they will be joined. It works only among pype-objects, also from different workbenches.\n\n: 16\\) Extend pipes to intersection\n\nBy selecting two pipes, this command extend them both to their intersection point, if exists.\n\n: 17\\) Extend pipe to intersection\n\nBy selecting two pipes, this command extend the first to the intersection with the other, if exists.\n\n: 18\\) Lay-down the pipes\n\nBy selecting one face and multiple pipes, this command translates the pipe along the normal of the face in order to make them lie on its plane.\n\n: 19\\) Raise-up the support\n\nSimilar to the tool above but in this case is the support that is raised or lowered, so that the face is tangent to the pipe.\n\n: 20\\) Attach to tube\n\nAttaches a pype object (2, 3, 4, 5 or 6) rigidly to the nearest end of a pipe (1). To detach, click on the button while the attached object is selected alone.\n\n: 21\\) Create pipes point-to-point\n\nOpens a dialog similar to \\\"Draw a DWire\\\" together with the dialog of \\\"Insert a pipe\\\": this allows to draw a sequence of pipes, connected by curves, just selecting one point after the other. It is also allowed to change properties of the pipe and/or the pype-line on the fly.\n\n: 22\\) Insert Any Shape\n\nThis is a tool to create a \\\"pype\\\" object from a .STEP or .IGES or .BREP file. It loads the imported file into the Shape property of a FeaturePython.\n\n## Utilities\n\n\n
\n\n![](images/Flamingos_utils.jpg )\n\n\n
\n\n\n: 1\\) Make a polygon\n\nThe first two tools of utils are part of a separate project which aims to create an automatic scanner of rooms with a stepper motor and an ultrasonic distance meter. This tool creates one regular polygon inside a sketch.\n\n: 2\\) Polygon from file\n\nTool to create any polygon inside a sketch taking vertexes from a .csv file, where they are stored in polar coordinates.\n\n: 3\\) Query the model\n\nTool to get various informations according to the object or objects selected. Beside length or distances, it is specifically suited to give informations related to beams and pipes (length, section, angle-between).\n\n: 4\\) Align workplane\n\nTool to set the position and rotation of working plane according to the selected existing geometry.\n\nThe normal of working plane is defined scanning the elements in the following order:\n\n1. the normal of a face\n2. the normal of the plane of a curve\n3. the normal of the plane containing two segments\n\nThe origin of working plane is defined (in order) by\n\n1. one vertex\n2. the center of curvature of a line\n3. the intersection of two lines\n4. the center of an edge\n\n: 5\\) Offset workplane\n\nShifts the working plane along its normal vector. To show the direction of offset, a temporary green arrow is displayed on the screen. Clearly also negative values are allowed.\n\n: 6\\) Rotate workplane\n\nRotates the working plane around one of its axis. Also in this case a green arrow is displayed in the viewport to identify the present orientation of the WP: the arrow is pointed in the Z direction and the long base of the arrow is layed over the X direction.\n\n: 7\\) Draw a DWire\n\nThis tool works exactly like the corresponding tool of Draft workbench but with few additional options at the end of the dialog. As default, the origin of working plane is redefined at each point added because this makes simpler to draw segments of known length and orientation using the snap-to-grid option. Then two push-buttons, invoked also with the short-key Ctrl+Shift+(), allow to rotate and offset the working plane as seen above without breaking the DWire object. The last three buttons allow to quickly change the rotation of working plane to be parallel to the principal planes.\n\n: 8\\) Quick move objects\n\nTo move quickly any part, to access the underlying objects for instance, this tool provides a graphic handle (green arrow) by clicking on which it\\'s possible to displace and rotate the selected objects.\n\n: 9\\) Pressure loss calculator\n\nOpens one dialog to calculate the pressure losses across the pype-parts selected in the viewport or across one PypeBranch. The friction coefficient is calculated for each straight tube and elbow. For other objects the concentrated pressure loss is calculated through the flow factor, provided that the attribute Kv is available and set to a positive value.\n\n## Links\n\n- Forum: [New workbench for metal structures](http://forum.freecadweb.org/viewtopic.php?f=8&t=17035) (announcement)\n- Forum: [Flamingo & Dodo workbench(s) discussion thread](https://forum.freecadweb.org/viewtopic.php?t=22711)\n- Tutorials: [flamingo/tutorials](https://github.com/oddtopus/flamingo/tree/master/tutorials)\n\n- Video tutorials:\n - [Simple video tutorial for frame creation with pipes](https://www.youtube.com/watch?v=_Or91gdBLMU)\n - [Part 1: how to created pipe lines](https://www.youtube.com/watch?v=cBj0umlvzAk)\n - [Part 2: frames, supports, flanges, and imported components](https://www.youtube.com/watch?v=e81PpWY5L00)\n - [Part 3: drawing one building with four sketches (and a bunch of other features)](https://www.youtube.com/watch?v=IqEccmsg5dU)\n - [Part 4 (1/2): Pump room layout and piping plan](https://www.youtube.com/watch?v=aPF8SS_1Aqo)\n - [Part 4 (2/2): Pump room import in building and pipe-route](https://www.youtube.com/watch?v=iGnW88x9bKQ)\n- Reporting bugs:\n - [Flamingo GitHub issue queue](https://github.com/oddtopus/flamingo/issues)\n - [Dodo GitHub issue queue](https://github.com/oddtopus/dodo/issues)\n\n## Other useful links \n\n- [External workbenches](External_workbenches.md)\n- [Macros recipes](Macros_recipes.md)\n- [OSE-Piping-Workbench: to create extra pipe fittings](https://wiki.opensourceecology.org/wiki/OSE_Piping_Workbench)\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) > Flamingo Workbench\n"} {"id": "freecad-docs:wiki/FreeCAD_on_video.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/FreeCAD_on_video.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/FreeCAD_on_video.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e03cf6711793e16219061d935e72af241eb6626f66395b85e6cc4bd4ab62d497", "bytes": 138, "tokens": 61, "text": "# FreeCAD on video\n1. REDIRECT [FreeCAD_on_Video](FreeCAD_on_Video.md)\n\n\n---\n⏵ [documentation index](../README.md) > FreeCAD on video\n"} {"id": "freecad-docs:wiki/Git.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Git.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Git.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9a7cf8b5a1f104877410f881f762fc6e516001c051febc51bfae45b2047e6670", "bytes": 124, "tokens": 46, "text": "# Git\n1. REDIRECT [Source code management](Source_code_management.md)\n\n\n---\n⏵ [documentation index](../README.md) > Git\n"} {"id": "freecad-docs:wiki/Google_Summer_of_Code_2023.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Google_Summer_of_Code_2023.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Google_Summer_of_Code_2023.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "aabc19d4b6c13b7a2ac6506faa5dec2abd3ad941529e247b6de4ce1b4bf0b451", "bytes": 13331, "tokens": 3597, "text": "# Google Summer of Code 2023\nFreeCAD started participating to the Google student coding program (GSoC) in 2016. We participated through a combined effort of many CAx projects, under the BRL-CAD umbrella. Beginning in 2023, we are applying as our own organization.\n\n- Main page of the program: \n- FreeCAD in GSoC: \n\n## How it works \n\n- The student writes a project proposal for FreeCAD.\n - Sometimes their project idea caters to something that the open source organization suggests and sometimes it\\'s an idea entirely of the student\\'s conception.\n- Proposals are reviewed, evaluated, and ranked by the open source organization\\'s mentors.\n- Google allocates a certain number of slots to each participating organization\n - That, in turn, determines how many student developers work with that organization.\n\nIf you want to get involved have a look at the [GSoC Checklist](GSoC_Checklist.md). Whether you\\'re applying or accepted, we\\'ve itemized everything you need to do in this list. We\\'re here to help you become new open source developers, so don\\'t be shy if you have any questions.\n\nWe are proposing a number of project ideas here. But you are in no way forced to follow our ideas. You can propose anything you would like to work on, that you thing would be an interesting project.\n\n## The Selection Process \n\nGSoC is about getting people involved and contributing to open source over the long-term. As such, we heavily weight our application selection process towards students that are interested in remaining involved in FreeCAD and open source software development long after GSoC has ended. GSoC is not a job. If you think this is just a summer job, then GSoC is probably not for you. It\\'s only like a job in terms of planning your time commitment over the summer.\n\nAdditionally, submissions are graded based on perception of the submitter\\'s abilities to complete the task within the program timeframe, general consensus on the technical approach being proposed, and overall interest in having such modifications made to FreeCAD. Particular notice is made of students that are responsive to questions and readily interactive in the IRC channel or on the forum. Communication is a great thing.\n\nJust about every GSoC organization receives considerably more project proposals than can be accepted. Every application gets read multiple times and reviewed in detail. Of those applications, only a small subset are selected so keep in mind that the selection process is rather competitive and difficult.\n\nWhether or not you are accepted, contributing to open source outside of GSoC is one of the main goals of the program and is the best way to be noticed and get your proposal accepted. Keep that in mind. Thanks for your interest and we look forward to working with new FreeCAD developers!\n\n## Possible Mentors \n\n[Bernd](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=2069), [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68), [Amritpal](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=9146), [Ickby](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=686), [Kkremitzki](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=7997), [Kunda1](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=12229), [WandererFan](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=1375), [Sliptonic](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=708) and others. The best way to contact us is through the [FreeCAD GSoC 2023 discussion thread](https://forum.freecad.org/viewtopic.php?t=75828).\n\n## Implementation Ideas \n\nThere are several sources for project ideas. The table below lists existing project ideas already documented on our wiki. FreeCAD also previously participated in an umbrella organization for GSoC, and there are [FreeCAD project ideas available in their GSoC repo](https://github.com/opencax/GSoC/issues?q=is%3Aissue+is%3Aopen+FreeCAD). Additionally, there is a [forum thread](https://forum.freecad.org/viewtopic.php?t=75828) calling for additional ideas which may be the basis of a project.\n\nThe ideas listed here or in the OpenCAx repo have a high chance of being accepted as project proposal. Note that for students with an established involvement in FreeCAD who have already contributed code, ideas in their own line of work are also welcome. Feel free to contact us on IRC, the forum or the mailing list for further discussions about the listed projects.\n\nThe topic\\'s priority shows you how important the work on the ideas is for the mentors, and hence choosing a high priority topic will give you an advantage if there are more applications than slots for FreeCAD. The size column shows the estimated time frame to complete the project, but you are of course free to suggest otherwise if you see arguments for it.\n\n Topic Language Size Difficulty Priority Contact\n \n [FreeCAD-BRLCAD integration](https://github.com/FreeCAD/FreeCAD/issues/8557): Allow to open, edit and save BRL-CAD models in FreeCAD C++ 350h High Medium [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68), [Daniel Rossberg](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=23847)\n [Upgrade the documentation system](https://github.com/FreeCAD/FreeCAD/issues/8558): Rework the documentation system so it supports multiple languages, and allows to switch between offline and online versions C++, Python 175h Medium Medium [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [GSoC FEM Solver Z88](https://github.com/FreeCAD/FreeCAD/issues/8559): Extend the capabilities of FEM solver Z88OS in FreeCAD FEM workbench. Python 175h Easy-Medium Low [Bernd](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=686)\n [Advanced FreeCAD test system](https://github.com/FreeCAD/FreeCAD/issues/8560): Create a framework for result file based comparisons and workbench specific comparators. Also creation of test cases should be simplified by a GUI or wizard. Python/C++ 175h Medium Low [Ickby](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=686)\n [Unified Measurement Facility](https://github.com/FreeCAD/FreeCAD/issues/8561): Create a generalized measurement tool that combines functionality from workbench-specific ones Python/C++ 175h Medium Low [Kkremitzki](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=7997)\n [Improve Hidden Line Removal](https://github.com/opencax/GSoC/issues/69): Develop new code for projecting shapes and creating the geometry for technical drawings C++ 350h Hard Low [WandererFan](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=1375)\n [Improving Headless mode](https://github.com/opencax/GSoC/issues/68): Exposing more FreeCAD functionality to the console that can run with and without the GUI available C++ 175h Medium Low [Kunda1](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=12229)\n [UI tool for fetching online content](https://github.com/opencax/GSoC/issues/39): Design a library tool that fetches the content online, without the need to download the whole library Python 175h Medium Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [Command-line preferences manipulation](https://github.com/opencax/GSoC/issues/38): Design a command-line tool that allows to create, modify or delete FreeCAD preference parameters C++ 175h Medium Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [Better materials structure](https://github.com/opencax/GSoC/issues/37): Invent a handier way to classify, store and select materials and implement that system FreeCAD-wide C++ and Python 175h Medium Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [Improve the API documentation](https://github.com/opencax/GSoC/issues/36): Work on the FreeCAD doxygen-generated documentation: Propose a better plan, document the modules better, make it clearer to read, etc. C++ and Python 175h Medium Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [Cabinet tool](https://github.com/opencax/GSoC/issues/35): Design a tool for the Arch workbench that allows a user to easily create several kinds of cabinets Python 350h Medium Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [Direct Modeling tools](https://github.com/opencax/GSoC/issues/17): Study and implement direct modeling tools in FreeCAD Python/C++ 350h Hard Low [Yorik](http://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=68)\n [On-Machine Inspection](https://github.com/opencax/GSoC/issues/8588): Problem: The Path Workbench lacks capability for On-machine inspection Python/C++ 175h Medium Low [Sliptonic](https://forum.freecad.org/memberlist.php?mode=viewprofile&u=708)\n\nNote also that any issue open on the \\[FreeCAD issues tracker \\] could become a good GSoC proposal. Don\\'t hesitate to browse the issues, the ones [marked as \\\"Feature\\\"](https://github.com/FreeCAD/FreeCAD/issues?q=is%3Aissue+is%3Aopen+label%3AFeature) are feature requests and might be especially interesting to you. If any of them picks your brain, feel free to discuss it, either directly on the issue itself, or on the [forum thread](https://forum.freecad.org/viewtopic.php?t=75828).\n\n## Schedule\n\n- January 23 - 18:00 UTC: Mentoring organizations can begin submitting applications to Google\n- February 7 - 18:00 UTC: Mentoring organization application deadline\n- February 7 - 21: Google program administrators review organization applications\n- February 22 - 18:00 UTC: List of accepted mentoring organizations published\n- February 22 - March 19: Potential GSoC contributors discuss application ideas with mentoring organizations\n- March 20 - 18:00 UTC: GSoC contributor application period begins\n- April 4 - 18:00 UTC: GSoC contributor application deadline\n- April 27 - 18:00 UTC: GSoC contributor proposal rankings due from Org Admins\n- May 4 - 18:00 UTC: Accepted GSoC contributor projects announced\n- May 4 - 28: Community Bonding Period \\| GSoC contributors get to know mentors, read documentation, get up to speed to begin working on their projects\n- May 29: Coding officially begins!\n- July 10 - 18:00 UTC: Mentors and GSoC contributors can begin submitting midterm evaluations\n- July 14 - 18:00 UTC: Midterm evaluation deadline (standard coding period)\n- July 14 - August 21: Work Period \\| GSoC contributors work on their project with guidance from Mentors\n- August 21 - 28 - 18:00 UTC: Final week: GSoC contributors submit their final work product and their final mentor evaluation (standard coding period)\n- August 28 - September 4 - 18:00 UTC: Mentors submit final GSoC contributor evaluations (standard coding period)\n- September 5: Initial results of Google Summer of Code 2023 announced\n- September 4 - November 6: GSoC contributors with extended timelines continue coding\n- November 6 - 18:00 UTC: Final date for all GSoC contributors to submit their final work product and final evaluation\n- November 13 - 18:00 UTC: Final date for mentors to submit evaluations for GSoC contributor projects with extended deadlines\n\n## Previous GSOCs \n\n- [Google Summer of Code 2022](Google_Summer_of_Code_2022.md)\n- [Google Summer of Code 2020](Google_Summer_of_Code_2020.md)\n- [Google Summer of Code 2019](Google_Summer_of_Code_2019.md)\n- [Google Summer of Code 2018](Google_Summer_of_Code_2018.md)\n- [Google Summer of Code 2017](Google_Summer_of_Code_2017.md)\n\n\n---\n⏵ [documentation index](../README.md) > Google Summer of Code 2023\n"} {"id": "freecad-docs:wiki/Import_from_STL_or_OBJ.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Import_from_STL_or_OBJ.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Import_from_STL_or_OBJ.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "89bb565cbc58fae7889570a1e19eb9eacdc4912f60c5199d73eaf7863f96a986", "bytes": 5767, "tokens": 1713, "text": "# Import from STL or OBJ\n{{TutorialInfo\n|Topic= Import from STL or OBJ\n|Level= Beginner\n|Time= 30 minutes\n|Author=r-frank\n|FCVersion=0.16.6703\n|Files=\n}}\n\n## Introduction\n\nIn this tutorial we will cover how to import STL/OBJ files in FreeCAD. Since the mesh-format STL/OBJ is dimensionless, FreeCAD will assume on import that the units used in the model are mm. If this is not the case you have to scale your model either in the application it was created with (before exporting it) or you have to scale your model in FreeCAD after import and conversion to a solid.\n\n## Sample part \n\nFor this tutorial you can use your own STL file or create a demo file by doing this:\n\n- Open FreeCAD\n- Create a new document\n- Switch to the mesh workbench\n- Insert a torus by clicking on **Meshes** → ** Regular solid...**, choosing settings like:\n - Radius1: 10 mm\n - Radius2: 2 mm\n - Sampling: 50\n- Click on **Create** and then on **Close**\n- Save your file with **File** → **Save** to get a FreeCAD-File containing a mesh object\n\nFor importing a STL or OBJ file into FreeCAD, create a new FreeCAD document und choose **File** → **Import** from the top menu.\n\n## Cleaning and repairing the STL/OBJ-File for preparing import \n\nBasically, FreeCAD would import any STL/OBJ-File. But our goal is to have a solid which can be measured and changed (adding pads/pockets ..). For a successful conversion from mesh to solid we need to make sure that the mesh is \"water-tight\" (has no holes) or doesn't have any other errors.\nFreeCAD's aim is not to be a good mesh modeler, it is designed to be a solid modeler. FreeCAD has some capabilities for mesh operation in mesh workbench and OpenSCAD workbench (some operations need OpenSCAD to be installed and configured in the FreeCAD-preferences).\nSome users like to use third-party software for cleaning and repairing meshes, for example\n\n- [Netfabb Basic](http://www.netfabb.com/downloadcenter.php?basic=1) (Windows/Linux/Mac) - free for personal use (automatic mesh repair available)\n- [Meshlab](http://meshlab.sourceforge.net/) (Windows/Linux/Mac) - Open Source\n\nIn this tutorial we will use the mesh workbench within FreeCAD to clean/repair/verify the mesh of our sample file.\n\n### Automatic testing and repairing \n\n- Open FreeCAD and the sample FreeCAD file containing the mesh object\n- Switch to mesh workbench\n- Make sure that your mesh object is selected in the tree view\n- Choose **Meshes** → **Analyze** → **Evaluate & Repair mesh...** from the top menu\n- Make sure the pull down menu on the top right corner displays the name of your mesh object\n- With the last point in the list reading \\\"All above tests together\\\" click on **Analyze**\n- The texts beside the tick boxes will change to reflect results of the different tests\n- If errors had been detected the corresponding check-boxes will be ticked and you will be able to select **Repair**\n- Choose **Close** to close the menu\n\n### Harmonizing normals \n\nHarmonizing normals of a mesh object can be done by\n\n- Selecting your mesh object in the tree view\n- Choose **Meshes** → ** Harmonize normals** from the top menu.\n\nTip: By choosing the mesh object in the tree view, going to the view tab in the property view and changing \\\"Lighting\\\" from \\\"Two Side\\\" to \\\"One Side\\\" you can identify triangles with flipped normals. If the normals point into the mesh the triangle will be shown in black.\n\n### Closing holes \n\nYou can also manually close holes in your mesh object by\n\n- Selecting your mesh object in the tree view\n- Choose **Meshes** → **Fill holes...** from the top menu\n- Specify maximum number of edges to be filled (3 is default)\n- Since STL and OBJ are meshes consisting of triangles the default number of edges should be sufficient\n\nAnother method of manually closing holes in your mesh object would be\n\n- Selecting your mesh object in the tree view\n- Choose **Meshes** → ** Close hole** from the top menu\n- Select one of the edges of the hole in the mesh object in the 3D view\n- Right-Click in 3D view and choose **Leave hole-filling mode** to exit the command\n\n## Conversion mesh to solid \n\n- Switch to \"\" [Part Workbench](Part_Workbench.md)\n- Make sure your mesh object is selected in the tree view, otherwise select it\n- Choose **Part** → ** Create shape from mesh ...** from top menu\n- Specify tolerance for sewing shape (0,1 is default)\n- A new object will be created in the tree view (with blue shape icon, instead of green mesh icon)\n- Select the newly created object in the tree view\n- Choose **Part** → **Create a copy** → ** Refine shape** from the top menu\n- A new object will be created in the tree view and the previous one will be made invisible\n- Select the newly created object in the tree view\n- Choose **Part** → **Convert to solid** from the top menu\n- A new object will be created in the tree view, bearing \\\"(Solid)\\\" in its name, to indicate it is a solid\n\nSince the created solid has no history and no editable features (like a simple copy in FreeCAD) you could delete all previous objects from the tree view. This would keep your file size small \\...\n\n## Links\n\n- [Export to STL or OBJ](Export_to_STL_or_OBJ.md)\n- [Import Export](Import_Export.md)\n\n\n---\n⏵ [documentation index](../README.md) > [File_Formats](Category_File_Formats.md) > [Import](Import_Workbench.md) > Import from STL or OBJ\n"} {"id": "freecad-docs:wiki/Installing_on_Linux.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Installing_on_Linux.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Installing_on_Linux.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ea4ab34d3613d42226d94c9d3d3a662a9a2e612dd21bf5c8fe9d5ddca4ceff1a", "bytes": 11782, "tokens": 3457, "text": "# Installing on Linux\n## Overview\n\nThe installation of FreeCAD on most well-known Linux systems is endorsed by the community, and FreeCAD is available via the package manager on those systems. The FreeCAD team also provides some:\n\n- \\\"Official\\\" packages when new releases are made available via [Snap packages](Ubuntu_Snap.md), [AppImages](AppImage.md), [Flatpaks](Flatpak.md) and the [PPA](#Stable_PPA_version.md)\n- Experimental or \\'bleeding edge\\' builds available via [PPA](#Development_PPA_.28Daily.29.md) daily repository, [AppImages](AppImage.md), [Ubuntu Snaps](Ubuntu_Snap.md).\n\n\n
\n\n\n## Ubuntu and Ubuntu-based systems \n\nMany Linux distributions are based on Ubuntu and share its repositories. Besides official variants (Kubuntu, Lubuntu and Xubuntu), there are non official derivatives like Linux Mint, Voyager and others. The installation options below (Expand) should be compatible with these systems. \n\n\n
\n\n\n### Official version \n\nFreeCAD is available from the Ubuntu Universe repository, and can be installed via the **Software Center** or from the terminal:\n\n \n```python\nsudo apt install freecad\n```\n\n\n**Note:**\n\nthe Ubuntu Universe package may be outdated as the packaging may lag behind the latest stable source code. In this case, it is suggested to install the package from the `-stable` PPA below. In addition, installing the `-daily` package can be done to test the development branch.\n\n### Stable PPA version \n\n**Warning:** The FreeCAD PPA is currently unmaintained and [looking for volunteers](https://forum.freecadweb.org/viewtopic.php?f=42&t=69055&start=20). Please use an alternative (snap, appimage) until the issue is fixed!\n\nPersonal Package Archive (PPA) for the stable FreeCAD release is maintained by the FreeCAD community on Launchpad. The Launchpad repository is called [FreeCAD Stable Releases](https://launchpad.net/~freecad-maintainers/+archive/freecad-stable) .\n\n#### GUI\n\nInstall the stable PPA via the Graphical User Interface (GUI):\n\n: 1\\. Navigate to **Ubuntu Software → Software & Updates → Software Sources → Other Software**\n: 2\\. Click on **Add**, then copy and paste the following line\n\n\n: \n\n : \n \n```python\n ppa:freecad-maintainers/freecad-stable\n \n```\n \n\n\n: 3\\. Add the source, close the dialog, and reload your software sources, if asked.\n\nNow you can find and install the last stable FreeCAD version from the **Ubuntu Software Center**.\n\n#### CLI\n\nInstall the stable PPA via the Command Line Interface (CLI):\n\n: 1\\. Add the PPA to your software sources:\n\n\n: \n\n : \n \n```python\n sudo add-apt-repository ppa:freecad-maintainers/freecad-stable\n \n```\n \n\n\n: 2\\. Retrieve the updated package lists:\n\n\n: \n\n : \n \n```python\n sudo apt update\n \n```\n \n\n\n: 3\\. Then install FreeCAD along with its offline documentation:\n\n\n: \n\n : \n \n```python\n sudo apt install freecad freecad-doc\n \n```\n \n\n\n**Note:**\n\ndue to packaging problems, in certain versions of Ubuntu the `freecad-doc` package has collided with the installation of FreeCAD or one of its dependencies; if this is the case, remove the `freecad-doc` package, and only install the `freecad` package. If the `freecad-doc` package doesn\\'t exist, then ignore it.\n\n#### Checking Installation \n\n: 4\\. Once you have the stable PPA added to your sources using one of the above methods, the `freecad` package will install this PPA version over the one provided by the Ubuntu Universe repository. You can see the available versions with the following `apt-cache` command:\n\n\n: \n \n```python\n apt-cache policy freecad\n \n```\n \n\n\n: The output should look similar to the following (of course the version info will vary):\n\n \n```python\nfreecad:\n Installed: (none)\n Candidate: 2:0.18.4+dfsg1~201911060029~ubuntu18.04.1\n Version table:\n 2:0.18.4+dfsg1~201911060029~ubuntu18.04.1 500\n 500 http://ppa.launchpad.net/freecad-maintainers/freecad-stable/ubuntu bionic/main amd64 Packages\n 0.16.6712+dfsg1-1ubuntu2 500\n 500 http://archive.ubuntu.com/ubuntu bionic/universe amd64 Packages\nubuntu@ubuntu:~$ apt-cache policy freecad-doc\n```\n\n: 5\\. Invoke the stable (PPA) version of FreeCAD from the GUI or CLI. The latter method is as follows:\n\n\n: \n \n```python\n ./freecad\n \n```\n \n\n\n### Development PPA (Daily) \n\nAs FreeCAD is in constant development, you may wish to install the **daily** package to keep with the latest improvements and bug fixes. The repository is also hosted on Launchpad and is called [freecad-daily](https://launchpad.net/~freecad-maintainers/+archive/freecad-daily).\n\nThis version is compiled daily from the official master repository. Please beware that although it will contain new features and bug fixes, it may also have newer bugs, and be unstable.\n\nAdd the daily PPA to your software sources, update the package lists, and install the daily package: \n```python\nsudo add-apt-repository ppa:freecad-maintainers/freecad-daily\nsudo apt-get update\nsudo apt-get install freecad-daily\n```\n\nEvery day you can update to the latest daily: \n```python\nsudo apt-get update\nsudo apt-get install freecad-daily\n```\n\n\n**Note:**\n\nin some cases new code or dependencies added to FreeCAD will cause packaging errors; if this happens, a daily package may not be generated until the maintainers manually fix the problems. If you wish to continue testing the latest code, you should get the source code and compile FreeCAD directly; for instructions see [compiling](compiling.md).\n\nRun the daily (PPA) version of FreeCAD: \n\n: \n \n```python\n freecad-daily\n \n```\n \n\n\n**Note:**\n\nit is possible to install both the \n\n\n
\n\n\n
\n\n\n## Debian and other Debian-based systems \n\nSince Debian Lenny, FreeCAD is available directly from the Debian software repositories and can be installed via synaptic or simply with:\n\n \n```python\nsudo apt-get install freecad\n``` \n\n\n
\n\n\n## OpenSUSE\n\nFreeCAD is typically installed with YAST (abbr. Yet another Setup Tool) the Linux operating system setup and configuration tool, or in any terminal/console (root rights required) with:\n\n\n: \n \n```python\n zypper install FreeCAD\n \n```\n \n\n\n**Note:**\n\nThis procedure only covers the installation of officially released **stable** FreeCAD program versions, depending on the installed links to the program package repositories of your OS version. The openSUSE package *may be outdated* as the packaging may lag behind the latest stable source code. In this case, it is suggested to install the package manually from the below indicated (Expand) source repositories. \n\n\n
\n\n\nA vast release program for FreeCAD package builds are offered. Please visit for a survey:\n\n**[Survey of repositories on openSUSE](https://software.opensuse.org/search?utf8=%E2%9C%93&baseproject=ALL&q=FreeCAD)**\n\nGenerally for selecting the correct openSUSE distribution needed it is necessary to click on the particular **View** button.\n\n### Stable\n\nThe stable package version: [Stable repositories on openSUSE](https://software.opensuse.org/package/FreeCAD). The correct openSUSE distribution version must be selected in the lower part of the web page.\n\nNote: openSUSE has several options to choose from when downloading FreeCAD. To view these options, visit [Survey of stable repositories on openSUSE](https://software.opensuse.org/search?utf8=%E2%9C%93&baseproject=ALL&q=FreeCAD).\n\n### Development\n\nLatest development releases AKA **unstable**: [Unstable repositories listings on openSUSE](https://software.opensuse.org/download.html?project=science%3Aunstable&package=FreeCAD)\n\nIt is recommended to grab the binary packages directly. Then select the correct distribution for your installed openSUSE OS. \n\n\n
\n\n\n
\n\n\n## Gentoo\n\nFreeCAD can be built/installed simply by issuing:\n\n \n```python\nemerge freecad\n``` \n\n\n
\n\n\n## Fedora\n\nFreeCAD has been included in the official Fedora packages since Fedora 20. It can be installed from the command line with:\n\n \n```python\nsudo dnf install freecad\n``` \n\n\n
\n\n On older Fedora releases, that was:\n\n \n```python\nsudo yum install freecad\n```\n\nThe gui packages managers can also be used. Search for \\\"freecad\\\".\n\nThe official release package version tends to be well behind the FreeCAD releases. [Package: freecad](http://rpms.remirepo.net/rpmphp/zoom.php?rpm=freecad) shows the versions included in the Fedora repositories over time and versions.\n\nMore current versions can be obtained by downloading one of the [.AppImage](https://github.com/FreeCAD/FreeCAD/releases/) releases from the github repository. These work fine on Fedora.\n\nIf you want to keep up with the absolute latest daily builds, FreeCAD is also available on [copr](https://copr.fedorainfracloud.org/groups/g/freecad/coprs/) . To install the build from there, in a terminal session, enter:\n\n \n```python\nsudo dnf copr enable @freecad/nightly\nsudo dnf install freecad\n```\n\nThat leaves the copr repository active, so\n\n \n```python\nsudo dnf upgrade\n```\n\nor equivalent, will update to the latest FreeCAD build, along with updates from any of the other active repos. If you want something a bit more stable, you can disable \\@freecad/nightly again after the initial install. The copr repository only keeps builds from the past 2 weeks. This is not a solution if you want to pick a specific older version.\n\nInstructions are also available on [compile FreeCAD yourself](Compile_on_Linux.md), including a script specifically for Fedora. With a minor change, to checkout the specific commit from git, any version since about FreeCAD 0.15 can be built on any distribution since Fedora 21. \n\n\n
\n\n\n
\n\n\n## Arch\n\nInstalling FreeCAD on Arch Linux and derivatives (ex. Manjaro):\n\n \n```python\npacman -S freecad\n```\n\n## Other\n\nIf you find out that your system features FreeCAD but is not documented in this page, please tell us on the [forum](http://forum.freecadweb.org/viewforum.php?f=21)!\n\nMany alternative, non-official FreeCAD packages are available on the net, for example for systems like slackware or fedora. A search on the net can quickly give you some results.\n\n### Installing on other Linux/Unix systems \n\nMany common Linux distros now include a precompiled FreeCAD as part of the standard packages. This is often out of date, but is a place to start. Check the standard package managers for your system. One of the following (partial) list of commands could install the official version of FreeCAD for your distro from the terminal. These probably need administrator privileges.\n\n \n```python\napt-get install freecad\ndnf install freecad\nemerge freecad\nslackpkg install freecad\nyum install freecad\nzypper install freecad\npacman -Sy freecad\n```\n\nThe package name is case sensitive, so try \\[.AppImage](https://github.com/FreeCAD/FreeCAD/releases/) releases from the github repository. These also tend to work on most x86_64 Linux distributions, without any special installation. Just make sure the downloaded file is marked as executable, then run it.\n\nIf that still is not good enough, and you cannot locate another source of a precompiled package for your situation, you will need to [compile FreeCAD yourself](Compile_on_Linux.md).\n\n## Next Step \n\nHead to [Getting started](Getting_started.md) once installation is complete.\n\n\n---\n⏵ [documentation index](../README.md) > [Common Questions](Category_Common%20Questions.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Installing on Linux\n"} {"id": "freecad-docs:wiki/Macro_AeroFoil.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_AeroFoil.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_AeroFoil.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "65c1c3f9be6b4f28aae17080923b174bec411d627de41a0f21f8544b830c3964", "bytes": 8203, "tokens": 3100, "text": "# Macro AeroFoil\n{{Macro\n|Name=Macro AeroFoil\n|Icon=AeroFoil.png\n|Description=AeroFoil creates airfoil curves and faces using pre-defined models, algebraic functions, and DAT or CSV Files.\n|Author=Melwyncarlo\n|Date=2021-03-10\n|Version=2.0.1\n|FCVersion=(v0.17) \n|Download=[https://wiki.freecad.org/images/5/59/AeroFoil-reduced.png ToolBar Icon]\n|Links=[https://github.com/melwyncarlo/AeroFoil Personal Github - AeroFoil]
[https://github.com/melwyncarlo/AeroFoil/blob/main/AeroFoil.zip?raw=true AeroFoil.zip]
[https://github.com/FreeCAD/FreeCAD-macros/tree/master/ObjectCreation FC Github - AeroFoil]
[https://forum.freecadweb.org/viewtopic.php?f=22&t=56162 FC Forum - AeroFoil]\n}}\n\n## Description\n\n**AeroFoil** is a user-created macro to be used within the FreeCAD application. AeroFoil creates airfoil curves and faces using pre-defined models, algebraic functions, as well as imported DAT or CSV files.\n\n![](images/AeroFoil-reduced.png )    This is the **AeroFoil Macro** icon.\n\nThe AeroFoil Macro can be downloaded using the in-built [Addon Manager](Std_AddonMgr.md) within the FreeCAD software.\n\n#### Key Features \n\n- Airfoil points refinement\n- Multiple airfoil copy generation\n- 2D curves and planar face output\n- DWire/PolyLine and BSpline output\n- Sketcher workbench and Draft workbench output\n- Fully constrained sketches in Sketcher workbench\n- Split (upper and lower) airfoil curves generation\n- Ready-made NACA 4-digit and 5-digit solvers\n- Symmetric and asymmetric curve functions parser\n- DAT text file and CSV spreadsheet data parser\n- Chord length input in mm, cm, m, in., ft, and yards\n\n#### Additional Features (v0.19) \n\nAeroFoil object properties *(read-only)* :\n{{Properties Title|Base}}\n\n- **Airfoil Type|String**\n \n\n- **Airfoil Chord Length|Length**\n \n\n- **Design Curve Type|String**\n \n\n- **Number Of Points|Integer**\n \n\n\\[\\[\\|\n\n\n
\n\nCaption : AeroFoil Macro Output Types\n\n\n
\n\n\\]\\]\n\n\\[\\[\\|\n\n\n
\n\nCaption : AeroFoil Macro Input Types\n\n\n
\n\n\\]\\]\n\n## Installation\n\n#### Linux\n\nAeroFoil can be installed manually, similar to Windows installation, or by using the command terminal and its relevant commands as mentioned in the [INSTALL](https://raw.githubusercontent.com/melwyncarlo/AeroFoil/main/INSTALL.sh) file.\n\nBy default, the Linux command terminal can be launched by pressing the following keyboard keys simultaneously :\n\n**Control** + **Alt** + **T**\n\n#### Windows\n\nAeroFoil can be installed with the help of the following two steps :-\n\n1. Download the [AeroFoil.zip](https://github.com/melwyncarlo/AeroFoil/blob/main/AeroFoil.zip?raw=true) file.\n2. Extract the ZIP file\\'s contents into the FreeCAD User Macro directory location.\n\nBy default, the FreeCAD User Macro directory should be located at :\n\n \n\n## Usage\n\nAeroFoil can be loaded by performing the following steps :-\n\n1. Launch the **FreeCAD** application.\n2. Go to **Macro → Macros ...**.\n3. Click on the **User macros** tab in the pop-up dialog box.\n4. Select **AeroFoil.FCMacro**.\n5. Click on **Execute**.\n\nOnce the AeroFoil macro has been loaded, follow the instructions in the respective dialog boxes, fill in the relevant inputs, and navigate accordingly. In case of error or warning, you will automatically be notified of the same. In case you are notified to report an unexpected error, communicate the error by mentioning the FreeCAD version, tracing the steps taken, and mentioning whether (and how much) or not any ouput was generated.\n\n#### Notes\n\n \n \\(1\\) Performing the macro operation with custom points and refinement produces no visible changes.\n \\(2\\) The AeroFoil object properties are only visible on the FreeCAD software version 0.19. On older versions, you will be shown a warning on the console. This warning will not affect the output.\n \n \n\n#### Hints to keep in mind during usage : \n\n1. For the NACA airfoils, the last two digits (combined) cannot have a value of zero; thickness cannot be a zero value.\n2. The NACA 5-digit airfoils are limited to the following models (\\'XX\\' denotes the last two digits, thickness, of the airfoil) :\n - 210XX\n - 220XX\n - 221XX\n - 230XX\n - 231XX\n - 240XX\n - 241XX\n - 250XX\n - 251XX\n3. For curve functions, only use the preset characters and functions.\n4. For curve functions, $2 * x$ is correct, whereas $2x$ is incorrect.\n5. For curve functions, $y = f(x)$ ranges from **0** to **1**, both inclusive.\n6. For curve functions, the trigonometric *theta* is in degrees (**θ °**)\n7. For curve functions, the trigonometric *theta* ranges from **0°** to **360°**, subject to computational limits.\n8. Curves or points that are intersecting between **0** and **1**, both exclusive, will return an error.\n9. Curves or points that contain the bottom airfoil data cannot be mirrored\n10. For file imports, it is suggested to leave the line, row, and column numbers to their default values, unless you are well-informed.\n11. Increasing the **refine** and **quantity** parameters increases the computation time and resources.\n12. Absolute chord length, in millimetres, cannot be less than **1mm**.\n\n\\[\\[\\|\n\n\n
\n\nCaption : Preset Characters and Functions\n\n\n
\n\n\\]\\]\n\n## Script\n\n {{MacroCode|code=\n\n__Title__ = \"AeroFoil\"\n__Author__ = \"Melwyncarlo\"\n__Version__ = \"2.0.0\"\n__Date__ = \"2021-03-09\"\n__Comment__ = \"AeroFoil creates airfoil curves and faces using pre-defined models, algebraic functions, and DAT or CSV Files\"\n__Web__ = \"https://github.com/melwyncarlo/AeroFoil\"\n__Wiki__ = \"http://www.freecadweb.org/wiki/index.php?title=Macro_AeroFoil\"\n__Icon__ = \"https://wiki.freecad.org/images/5/59/AeroFoil-reduced.png\"\n__Help__ = \"Click on the AeroFoil button/macro, and follow the instructions in the subsequent dialog boxes.\"\n__Status__ = \"stable\"\n__Requires__ = \"Freecad >= v0.17\"\n__Communication__ = \"https://github.com/melwyncarlo/AeroFoil/issues\"\n__Files__ = \"AeroFoil_UI_Files/AeroFoil_Initial_Dialog.ui, AeroFoil_UI_Files/AeroFoil_NACA4Digit_Dialog.ui, \\\nAeroFoil_UI_Files/AeroFoil_NACA5Digit_Dialog.ui, AeroFoil_UI_Files/AeroFoil_CurvesInput_Dialog.ui, \\\nAeroFoil_UI_Files/AeroFoil_PointsInput_Dialog.ui, AeroFoil_UI_Files/AeroFoil_DATInput_Dialog.ui, \\\nAeroFoil_UI_Files/AeroFoil_CSVInput_Dialog.ui, AeroFoil_UI_Files/AeroFoil_FileLoad_Dialog.ui, \\\nAeroFoil_UI_Files/AeroFoil_Final_Dialog.ui, AeroFoil_UI_Files/AeroFoil_Math_Functions_Box.ui, \\\nAeroFoil_UI_Files/AeroFoil_mfb_img.gif, AeroFoil_UI_Files/AeroFoil.svg\"\n\n\n# OS: Ubuntu 18.04.5 LTS\n# Word size of OS: 64-bit\n# Word size of FreeCAD: 64-bit\n# Version: 0.18.4.\n# Build type: Release\n# Python version: 3.6.8\n# Qt version: 5.9.5\n# Coin version: 4.0.0a\n# OCC version: 7.3.0\n# Locale: English/UnitedKingdom (en_GB)\n\n# OS: Ubuntu 18.04.5 LTS (LXDE/Lubuntu)\n# Word size of OS : 64-bit\n# Word size of FreeCAD: 64-bit\n# Version: 0.19\n# Build type: Release\n# Branch: unknown\n# Hash: 32200b604d421c4dad527fe587a7d047cf953b4f\n# Python version: 3.6.9\n# Qt version: 5.9.5\n# Coin versio: 4.0.0a\n# OCC version: 7.3.0\n# Locale: English/UnitedKingdom (en_GB)\n\n\n}}\n\n \n\n## Links\n\n\\[1\\] [AeroFoil Github Repository](https://github.com/melwyncarlo/AeroFoil)\n\\[2\\] [FreeCAD Macros Github Repository - AeroFoil](https://github.com/FreeCAD/FreeCAD-macros/tree/master/ObjectCreation)\n\\[3\\] [FreeCAD Forum Discussion Page - AeroFoil](https://forum.freecadweb.org/viewtopic.php?f=22&t=56162)\n\\[4\\] [Airfoil Tools](http://airfoiltools.com/) contains about 1,638 different airfoils.\n\\[5\\] [UIUC Airfoil Coordinates Database](https://m-selig.ae.illinois.edu/ads/coord_database.html) contains nearly 1,600 different airfoils.\n\n\n---\n⏵ [documentation index](../README.md) > Macro AeroFoil\n"} {"id": "freecad-docs:wiki/Macro_Arch_Axis_System_Repartition.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Arch_Axis_System_Repartition.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Arch_Axis_System_Repartition.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "41dc29e4bd85d5cbe8e9a1469de1e9f81635f9a129e2cca9803b08592a3b2376", "bytes": 13025, "tokens": 4053, "text": "# Macro Arch Axis System Repartition\n{{Macro\n|Name=Macro Arch Axis System Repartition\n|Icon=Macro_Arch_Axis_System_Repartition.png\n|Description=This macro help you to create an Arch Axis System along a line with a set of parameters. You can even create a Structural System directly from the FreeCAD-Library.\n|Author=rockn\n|Version=1.0\n|Date=2014-12-22\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/a/a0/Macro_Arch_Axis_System_Repartition.png ToolBar Icon]\n}}\n\n\"\" \n*ArchAxisSystemRepartition*\n\n## Description\n\nThis macro help you to create an Arch Axis System along a line with a set of parameters. You can even create a Structural System directly from the FreeCAD-Library.\n\n## Usage\n\n- Launch the macro with or without selected line.\n- A Gui TaskPanel set up in the task widget.\n- Set the lenght : if a line is selected, setting length actualize and forced to the line length ; if there is nothing selected the length can be changed.\n- Set the desired regular spacing ; the number of divide and left spacing are automatically calculating.\n- Or set the desired number of divide quantity ; this make an equal divide with no left spacing.\n- Choose if you want the left spacing to be at the beginning of the repartition or at the end or each side equal.\n- Check if you want a piece at the begging of the line, you can set an offset (end line direction).\n- Check if you want a piece at the begging of the line, you can set an offset (start line direction).\n- To validate clic on Ok button :\n- If a line is selected the Arch Axis System take the placement of the line else the placement is 0.0.0.\n- If you have the FreeCAD-Library gui open, the FCStd or Step file selected is imported and a Structural System is made.\n\n## Script\n\n\nToolBar Icon ![](images/Macro_Arch_Axis_System_Repartition.png )\n\n**Macro_Repartition.FCMacro**\n\n\n #!/usr/bin/env python\n # -*- coding: utf-8 -*-\n\n #***************************************************************************\n #* *\n #* Copyright (c) 2014 Jonathan Wiedemann Macro Arch Axis System Repartition\n"} {"id": "freecad-docs:wiki/Macro_Center_Align_Objects_with_Faces_or_Edges.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Center_Align_Objects_with_Faces_or_Edges.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Center_Align_Objects_with_Faces_or_Edges.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ee09b6c42cf7d6f8469543e006016eddd1531809d4384b8c407adcc866f4654b", "bytes": 3121, "tokens": 1132, "text": "# Macro Center Align Objects with Faces or Edges\n**These tools are now included in the [Manipulator Workbench](Manipulator_Workbench.md). Install this workbench for the latest updates on these tools.**\n\n\n{{Macro\n|Name=Center Faces of Parts\n|Icon=Macro_Center_Align_Objects_with_Faces_or_Edges.svg\n|Description=This macro Aligns Objects through Faces or Edges constraints. These tools are now included in the [https://github.com/easyw/Manipulator Manipulator Workbench]. Install this workbench for the latest updates on these tools.\n|Author=easyw-fc\n|Version=1.5.3\n|Date=2017-10-01\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/e/ee/Macro_Center_Align_Objects_with_Faces_or_Edges.svg ToolBar Icon]
[https://www.freecadweb.org/wiki/images/3/3d/Manipulator_Mover.svg Mover-icon]
[https://www.freecadweb.org/wiki/images/1/10/Manipulator_Caliper.svg Caliper-icon]\n}}\n\n## Description\n\nThis macro Aligns Objects through Faces or Edges constraints\n\n \n\n## Tools\n\n**Aligner** \"\": a set of tools to move and align 3D parts\n\n**Mover** \"\": a set of tools to move and rotate 3D parts on different Axis\n\n**Measure** \"\": a set of tools to measure 3D parts, with some Snap facility and Radius, Length, Angle measurements.\n\nThese helpers work with **Part, App::Part and Body objects**. Each Tool can be **Floating** or **Docked Left or Right**.\n\n\n## OLD References \n\nThis macro covers the following constraints:\n\n- Concentric constraint among non cylindrical parts;\n- Constraint on center Faces and/or Edges.\n- It works also with the new Body and App::Part containers, as well as with STEP hierarchy.\n\n\n![](images/Center-align-faces.png )\n\n![](images/center-align-faces-in-action.gif )\n\n![](images/center-align-Body-objects.gif )\n\n![](images/utube-alignment-tool-tutorial.png )\n\n[Aligning tool video tutorial](https://youtu.be/qzixT157jJU)\n\n![](images/utube-alignment-STEP-models.png )\n\n[Aligning STEP models video tutorial](https://youtu.be/aQcPqhlgHBU)\n\n\n## Usage\n\nFaces or Edges constraint among non cylindrical parts: Just open a FC document, launch the Macro and select two or more Faces/Edges to be aligned. Click on Align button and that\\'s it!\n\n## Script\n\nThe icon for your toolbar \"\"\n\n**CenterAlignObjectswFacesEdges.py**\n\nAfter downloading the file here\nGitHub page\n\ncode:\n\nyou need to copy the file to your macro directory.\n[How to install macros](How_to_install_macros.md)\n\n## Link\n\nForum : [Faces or Edges constraint among non cylindrical parts Macro](http://forum.freecadweb.org/viewtopic.php?f=22&t=18655)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Center Align Objects with Faces or Edges\n"} {"id": "freecad-docs:wiki/Macro_Cut_Line.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Cut_Line.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Cut_Line.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e79478bd7526b497d391090b0bb97b1339e896197bac4165f401264e015a5e1e", "bytes": 5660, "tokens": 1705, "text": "# Macro Cut Line\n{{Macro\n|Name=Macro Cut Line\n|Icon=Macro_Cut_Line.png\n|Description=Cut a line giving as an argument number cut, create line, bicolor, create point. The new line is created in the real coordinate of object, not in the coordinate of the Body.
{{ColoredText|(Command line, paste this complete macro in the Python console)}}.\n|Author=mario52\n|Version=2.0\n|Date=2019/06/17\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/3/35/Macro_Cut_Line.png ToolBar Icon]\n}}\n\n## Description\n\nThis small macro cut a line and create a points , lines , two colours of line.\n\n \"\" \n*cutLine*\n\n## Usage\n\nCan be used from the Freecad macro editor.\n\n- **4 :** number cuts\n- **createPoint** : create points or not (0) (Defaut 1)\n- **createLine** : create line (\\>0) or not (0) (Defaut 0)\n- **biColor** : create line biColor (\\>0) or not (0) (Defaut 0)\n\nyou can change the default values in the macro.\n\nWith bisColor the lines on the original line is created by a white line red line white line \\.... the colors are modifiable in the code, line 20 and 23.\n\n## Script\n\n ToolBar Icon ![](images/Macro_Cut_Line.png )\n\n**Macro_cutLine.FCMacro**\n\n\n{{MacroCode|code=\n#################################################################\n# http://forum.freecadweb.org/viewtopic.php?f=3&t=4217&hilit=discretize\n# 08/03/2015 2019/06/17\n\n__title__ = \"cutLine\"\n__author__ = \"Mario52\"\n__version__ = \"00.02\"\n__date__ = \"2019/06/17\"\n\nimport Draft, Part\ndef cutLine(numberOfPoints = 2, createPoint = 1, createLine = 0, biColor = 0): # create a points of forme\n\n def createLines(numberOfPoints, points, biColor): # create line\n biscolor = 0\n for lin in range(numberOfPoints-1):\n creaLine = [FreeCAD.Vector(points[lin]),FreeCAD.Vector(points[lin+1])]\n wire = Draft.makeWire(creaLine,closed=False,face=False,support=None)\n if biColor != 0: # biColor \n if biscolor == 0:\n FreeCADGui.ActiveDocument.getObject(wire.Name).LineColor = (1.0,0.0,0.0) # 255 = 1 (10 = (1/255 * 10 ))\n biscolor = 1\n else:\n FreeCADGui.ActiveDocument.getObject(wire.Name).LineColor = (1.0,1.0,1.0) # 255 = 1 (10 = (1/255 * 10 ))\n biscolor = 0\n try:\n points = []\n points[:] = []\n selectionObjects = FreeCADGui.Selection.getSelectionEx() # getSelectionEx\n numberOfPoints += 1\n for selection in selectionObjects:\n compteur = pas = 0\n for selectedEdge in selection.SubObjects:\n FreeCAD.Console.PrintMessage(selectionObjects[0].SubElementNames[compteur] + \"\\n\") \n# print( selectionObjects[0].SubElementNames[compteur])# getSelectionEx\n compteur += 1 \n points = selectedEdge.discretize(numberOfPoints) \n if createLine != 0:\n createLines(numberOfPoints, points, biColor)\n for p in points:\n if createPoint != 0:\n Draft.makePoint( p.x, p.y, p.z)\n FreeCAD.Console.PrintMessage(str(compteur)+\" X\"+ str(p.x)+\" Y\"+ str(p.y)+ \" Z\"+ str(p.z) + \"\\n\")\n# print( compteur,\" X\", p.x, \" Y\", p.y, \" Z\", p.z)\n pas = 1 #\n\n if pas == 0: # the not SubObjects\n selectionObjects = FreeCADGui.Selection.getSelection() # select all elements\n FreeCAD.Console.PrintMessage(selectionObjects[0].Name + \"\\n\")\n# print( selectionObjects[0].Name) # getSelection()\n compteur = 0\n for ii in enumerate(selectionObjects[0].Shape.Edges): \n compteur += 1\n points = ii[1].discretize(numberOfPoints) # discretize the element\n for p in points:\n if createPoint != 0:\n Draft.makePoint( p.x, p.y, p.z) # create points\n FreeCAD.Console.PrintMessage(str(compteur)+\" X\"+ str(p.x)+\" Y\"+ str(p.y)+ \" Z\"+ str(p.z) + \"\\n\")\n# print( compteur, \" X\", p.x, \" Y\", p.y, \" Z\", p.z) # list and display the coordinates\n if createLine != 0:\n createLines(numberOfPoints, points, biColor)\n except:\n FreeCAD.Console.PrintError(\"Error\" + \"\\n\" + \"Give : cutLine(numberOfPoints = 2, createPoint = 1, createLine = 0, biColor = 0)\"+\"\\n\")\n FreeCAD.Console.PrintError(\"Select the complete shape or separate wire(s) line, circle ...\"+\"\\n\")\n\n# print( \"Error : Give cutLine(numberOfPoints = 2, createPoint = 1, createLine = 0, biColor = 0)\")\n\n# Example in command line (paste the macro in FC Python console) and write:\n#cutLine(2, createLine = 1, biColor = 1, createPoint = 0)\n\n}}\n\n\n## Example\n\nCan be used from the Freecad macro editor.\n\nIf the macro is copied in the Python console, you can you can use it by: \n\n\n```python\ncutLine(4, createLine = 1, biColor = 1, createPoint = 0)\n```\n\n\n## Links\n\nthis function use the function discretize [the original code](http://forum.freecadweb.org/viewtopic.php?f=3&t=4217&hilit=discretize)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Cut Line\n"} {"id": "freecad-docs:wiki/Macro_Easy_cutouts_for_Enclosure_Design.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Easy_cutouts_for_Enclosure_Design.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Easy_cutouts_for_Enclosure_Design.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "956f88833bccb293d31e666e634f1ac05f8b06a143f0c17f03d8bb5b1aadb359", "bytes": 11227, "tokens": 3422, "text": "# Macro Easy cutouts for Enclosure Design\n{{Macro\n|Name=Easy cutouts for Enclosure Design\n|Icon=Macro_Easy_cutouts_for_Enclosure_Design_icon.png\n|Description=This macro makes Cutouts for Enclosures in a very handy way. Just select a face of the object that is the base for the cutout and the macro will create a clone of the external outline with a margin of 0.5mm (set in the macro)
{{ColoredText|#ff0000|This macro needs to be upgraded}}\n|Author=maurice\n|Version=0.25\n|Date=2016-11-26\n|FCVersion=0.16\n|Download=[https://www.freecadweb.org/wiki/images/7/71/Macro_Easy_cutouts_for_Enclosure_Design_icon.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro makes Cutouts for Enclosures in a very handy way\n\nJust select a face of the object that is the base for the cutout and the macro will create a clone of the external outline with a margin of 0.5mm (set in the macro)\n\n\"\" \n*Here a demo with an Arduino Uno enclosure*\n\n## Usage\n\nJust select a face of the object that is the base for the cutout and the macro will create a clone of the external outline with a margin of 0.5mm (set in the macro)\n\n## Script\n\nThe Icon for you ToolBar ![](images/Macro_Easy_cutouts_for_Enclosure_Design_icon.png )\n\n\n**Macro_Easy_cutouts_for_Enclosure_Design.FCMacro**\n\n\n{{MacroCode|code=\n# -*- coding: utf-8 -*-\n# clone, enlarge & center clone-obj to selected obj\n#\n \n__title__ = \"Clone-Enlarge-Center Face for cutouts\"\n__author__ = \"maurice\"\n__url__ = \"kicad stepup\"\n__version__ = \"0.25\"\n__date__ = \"11.2016\"\n\nimport FreeCAD, FreeCADGui, Draft, Part, DraftTools\nfrom FreeCAD import Base\n\n\ndef say(msg):\n FreeCAD.Console.PrintMessage(msg)\n FreeCAD.Console.PrintMessage('\\n')\n\ndef sayw(msg):\n FreeCAD.Console.PrintWarning(msg)\n FreeCAD.Console.PrintWarning('\\n')\n \ndef getNormal(self):\n return self.Object.Shape.Faces[0].normalAt(0,0)\n\n#Init \nif Gui.ActiveDocument <> None:\n #say (Gui.ActiveDocument)\n\n cx = 1 # center x -> 1 \n cy = 1 # center y -> 1 \n cz = 1 # center z -> 1 # scaleX = 1.1 # scale factor for Clone\n # scaleY = 1.1 # scale factor for Clone\n # scaleZ = 1.1 # scale factor for Clonemargin = 0.5 #margin in mm\n extrudeLenght = 10 #10mm \n #selEx = FreeCADGui.Selection.getSelectionEx()\n sel = FreeCADGui.Selection.getSelection()#print sel[0].Label\n #objs = [selobj.Object for selobj in selEx]\n selF = FreeCADGui.Selection.getSelectionEx()#if len(Gui.Selection.getSelectionEx()[0].SubElementNames) <1:\n # stopif len(sel) > 0:\n FreeCADGui.Selection.removeSelection(sel[0])\n #for o in FreeCADGui.ActiveDocument.getObjects():\n # FreeCADGui.Selection.removeSelection(o.Name)\n coords = []\n j = 0\n #if len(sel) == 1: # only 1 object selected\n #if len(selF) == 1: # only 1 object selected\n if len(sel) > 0:\n if len(selF[0].SubElementNames) ==1:\n f_names=[]\n f = Draft.makeFacebinder(selF)\n f1=App.ActiveDocument.getObject(f.Name)\n face=0\n try:\n norm = f1.Shape.Faces[0].normalAt(0,0)\n say (norm)\n face=1\n except:\n App.Console.PrintMessage(\"Select ONLY one single Face of object!\"+\"\\n\")\n # stop\n if face==1:\n l = Draft.downgrade(f,delete=False)\n k = 0; bbM = 0\n for o in l:\n for w in o:\n #print w.Name\n f_names.append (w.Name)\n say(w.Name)\n if \"Facebinder\" not in w.Name:\n bb=w.Shape.BoundBox\n bbX=float(bb.XLength)\n bbY=float(bb.YLength)\n bbZ=float(bb.ZLength)\n say (str(bbX)+\";\"+str(bbY)+\";\"+str(bbZ))\n if bbX > bbM:\n bbM = bbX; m = k\n if bbY > bbM:\n bbM = bbY; m = k\n if bbZ > bbM:\n bbM = bbZ; m = k\n k=k+1\n print f_names\n k = 0\n #f_names=[]\n for o in l:\n for w in o:\n say(w.Name)\n #f_names.append (w.Name)\n if k!=m:\n say ( \"deleting \"+f_names[k] )\n FreeCAD.ActiveDocument.removeObject(f_names[k])\n else:\n FreeCADGui.ActiveDocument.getObject(f_names[k]).Visibility=False\n f = FreeCAD.ActiveDocument.addObject('Part::Extrusion', 'Extrude_for_cut')\n f = FreeCAD.ActiveDocument.getObject(f.Name)\n f.Base = FreeCAD.ActiveDocument.getObject(f_names[k])\n f.Dir = norm * extrudeLenght * -1\n f.Solid = (True)\n f.TaperAngle = (0)\n k=k+1 \n #FreeCAD.ActiveDocument.removeObject(f_names[len(l)])\n say( f_names )\n say( f_names[m] )\n say( bbM )\n \n FreeCADGui.Selection.addSelection(FreeCAD.ActiveDocument.getObject(f.Name))\n FreeCAD.ActiveDocument.recompute()\n \n sel = FreeCADGui.Selection.getSelection() \n #objs = [selobj.Object for selobj in selEx]\n \n coords = []\n j = 0\n s = sel[0].Shape\n \n bb=s.BoundBox\n \n bbX=float(bb.XLength)\n bbY=float(bb.YLength)\n bbZ=float(bb.ZLength)\n # boundBox\n boundBox_ = s.BoundBox\n \n a = str(boundBox_)\n a,b = a.split('(')\n c = b.split(',')\n oripl_X = float(c[0])\n oripl_Y = float(c[1])\n oripl_Z = float(c[2])\n coords.append ([oripl_X+bbX/2, oripl_Y+bbY/2, oripl_Z+bbZ/2])\n App.Console.PrintMessage(str(boundBox_)+\"\\r\\n\")\n App.Console.PrintMessage(\"BBox : \"+str(bbX)+\" x \"+str(bbY)+\" x \"+str(bbZ)+\"\\r\\n\")\n App.Console.PrintMessage(\"Base Pos : \"+str(oripl_X)+\" x \"+str(oripl_Y)+\" x \"+str(oripl_Z)+\"\\r\\n\")\n App.Console.PrintMessage(\"Center Pos : \"+str(oripl_X+bbX/2)+\" x \"+str(oripl_Y+bbY/2)+\" x \"+str(oripl_Z+bbZ/2)+\"\\r\\n\")\n App.Console.PrintMessage(\"Coords : \"+str(coords[j])+\"\\r\\n\")\n \n #objC = FreeCAD.ActiveDocument.addObject('Part::AttachableObjectPython', 'Clone_for_cut')\n #objC = FreeCAD.ActiveDocument.getObject(objC.Name)\n objC=Draft.clone(sel)\n if bbX!=0:\n scaleX = (bbX + 2*margin) / bbX\n else:\n scaleX = 1\n if bbY!=0:\n scaleY = (bbY + 2*margin) / bbY\n else:\n scaleY = 1\n if bbZ!=0:\n scaleZ = (bbZ + 2*margin) / bbZ\n else:\n scaleZ = 1\n objC.Scale = (scaleX,scaleY,scaleZ)\n #Draft.scale(objC,delta=App.Vector(scaleX,scaleY,scaleZ),center=App.Vector(0,0,0),copy=True,legacy=True)\n \n oL = sel[0].Label + \"_enlarged\"\n objC.Label = oL\n FreeCADGui.Selection.addSelection(objC)\n \n FreeCAD.ActiveDocument.recompute()\n \n selEx = FreeCADGui.Selection.getSelectionEx()\n objs = [selobj.Object for selobj in selEx]\n coords = []\n j = 0\n if len(objs) >= 1:\n for obj in objs:\n #s = objs[0].Shape\n s = obj.Shape\n \n # boundBox\n boundBox_ = s.BoundBox\n boundBoxLX = boundBox_.XLength\n boundBoxLY = boundBox_.YLength\n boundBoxLZ = boundBox_.ZLength\n \n a = str(boundBox_)\n a,b = a.split('(')\n c = b.split(',')\n oripl_X = float(c[0])\n oripl_Y = float(c[1])\n oripl_Z = float(c[2])\n coords.append ([oripl_X+boundBox_.XLength/2, oripl_Y+boundBox_.YLength/2, oripl_Z+boundBox_.ZLength/2])\n App.Console.PrintMessage(str(boundBox_)+\"\\r\\n\")\n App.Console.PrintMessage(\"BBox : \"+str(boundBox_.XLength)+\" x \"+str(boundBox_.YLength)+\" x \"+str(boundBox_.ZLength)+\"\\r\\n\")\n App.Console.PrintMessage(\"Base Pos : \"+str(oripl_X)+\" x \"+str(oripl_Y)+\" x \"+str(oripl_Z)+\"\\r\\n\")\n App.Console.PrintMessage(\"Center Pos : \"+str(oripl_X+boundBox_.XLength/2)+\" x \"+str(oripl_Y+boundBox_.YLength/2)+\" x \"+str(oripl_Z+boundBox_.ZLength/2)+\"\\r\\n\")\n App.Console.PrintMessage(\"Coords : \"+str(coords[j])+\"\\r\\n\")\n if j>0:\n if cx==1:\n coordNx=coords[0][0]-coords[j][0]\n else:\n coordNx=0\n if cy==1:\n coordNy=coords[0][1]-coords[j][1]\n else:\n coordNy=0\n if cz==1:\n coordNz=coords[0][2]-coords[j][2]\n else:\n coordNz=0\n obj.Placement.move(App.Vector(coordNx,coordNy,coordNz))\n App.Console.PrintMessage(\"Moved : \"+str(coordNx)+\" \"+str(coordNy)+\" \"+str(coordNz)+\"\\r\\n\")\n j=j+1\n \n App.Console.PrintMessage(\"_____________________\"+\"\\r\\n\")\n \n FreeCADGui.Selection.removeSelection(objs[0])\n FreeCADGui.ActiveDocument.getObject(objs[0].Name).Visibility=False\n FreeCADGui.ActiveDocument.getObject(objs[1].Name).Transparency=70\n App.ActiveDocument.recompute() \n \n else:\n App.Console.PrintMessage(\"Select ONLY one single Face of object!\"+\"\\n\")\n else:\n App.Console.PrintMessage(\"Select ONLY one single Face of object!\"+\"\\n\")\nelse:\n sayw(\"no document to work with\") \n #http://forum.freecadweb.org/viewtopic.php?t=4625\n\n}}\n\n\n## Link\n\nForum : [Easy cutouts for Enclosure Design Macro](http://forum.freecadweb.org/viewtopic.php?f=22&t=18488)\n\n\n---\n⏵ [documentation index](../README.md) > Macro Easy cutouts for Enclosure Design\n"} {"id": "freecad-docs:wiki/Macro_Express_Placement.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Express_Placement.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Express_Placement.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f6b3284cdf03fe28d729a6d15777bf4af9ce25163110b0367106ec98c3132238", "bytes": 15135, "tokens": 4195, "text": "# Macro Express Placement\n{{Macro\n|Name=Macro Express Placement\n|Description=Display and quickly edit a selected object's placement coordinates directly or via expressions.\n|Author=screeneroner\n|Download=[https://raw.githubusercontent.com/screeneroner/fc-express-placement/master/fc-express-placement.FCMacro Express Placement]\n|Version=1.0\n|Date=2023-08-01\n|FCVersion=Created and tested in 0.21\n|Icon=Std_AxisCross_example.svg\n}}\n\n## Description\n\nThe macro **Express Placement** is a FreeCAD GUI addon. It allows quick editing of the X, Y, Z placement coordinates for the currently selected object.\n\n## Difference and benefits \n\n![Standard vs Express](images/Standard_vs_express.png )\n\nOne double click to edit object placement instead of four sequential clicks - **you may work 4 times faster!**\n\n### Standard FreeCAD Placement (in red) \n\nThe standard FreeCAD built-in editor requires many additional mouse clicks before you actually start parameter editing, especially when using parametric expressions to position your object:\n\n1. Click on the Base/Placement item in the Property view to unfold the Placement tree.\n2. Click on the Position branch to unfold the X, Y, Z coordinates fields.\n3. Click on the desired coordinate to make the expression editing icon visible.\n4. Click the expression editing icon, which is so small that it may be a challenge to hit it.\n Alternatively, press the **=** key on the keyboard. This may take even longer than clicking the icon.\n\nYou must repeat these clicks when you select another object. Again and again\\...\n\n### Express Placement (in green) \n\nThe Express Placement macro creates a special panel for you. You may dock this panel to any suitable place. It shows three rows with X, Y, Z coordinates. These coordinates contain values and expression fields. They are available for editing with just one double click.\n\n## Installation\n\n### Addon Manager \n\nFind [Express Placement](https://wiki.freecad.org/Macro_Express_Placement) in FreeCAD Addon Manager and install it.\n\n### Direct Launch of Express Placement \n\nYou may download and use Express Placement addon immediately in your FreeCAD:\n\n1. Download the express-placement.FCMacro file and place it in the User Macros folder inside your FreeCAD installation folder.\n2. Execute it directly from the FreeCAD main menu Macro / Macros / User Macros.\n\n### Installing Express Placement Toolbar Button \n\nTo have an ability to quickly switch on the Express Placement table, you may place a button to quickly execute this macro and bring up the Express Placement table:\n\n1. Download the Express Placement.FCMacro file and place it in the User Macros folder inside your FreeCAD installation folder.\n2. Select the Express Placement macro in the User Macros panel, invoked from the FreeCAD main menu Macro / Macros / User Macros.\n3. Press the Toolbar button and follow the Walkthrough dialog to place the Express Placement button in the desired location in the FreeCAD toolbars.\n\n## Usage\n\nJust run the Express Placement macro directly or via the toolbar button, and you will see a new docked property window in your FreeCAD UI. You may drag it to any allowed place in the UI and close any time you won\\'t need it. Next time when it will be required again - run the macro or press the toolbar button again to bring up the Express Placement window.\n\nWhen you decide to change the placement of the selected object, just double-click on the desired cell in the Express Placement window and type a new value or edit the existing one. The new value will be directly written to your model.\n\n*If you find this add-on useful and feel it\\'s worth treating me to a couple-triple coffee cups in recognition of my work, at any time you may do it via [☕ Buy me a coffee](https://www.buymeacoffee.com/screeneroner)*\n\n## Script\n\nClick here to show/hide the Addon source code. \n\n\n
\n\n\n{{MacroCode|code=\n\n# -*- coding: utf-8 -*-\n__Name__ = \"Express Placement\"\n__Comment__ = \"FreeCAD GUI addon that allow quick editing X,Y,Z coordinates of the selected object\"\n__Author__ = \"screeneroner\"\n__Version__ = \"1.0\"\n__Date__ = \"2023-08-01\"\n__License__ = \"GPL-3.0\"\n__Web__ = \"https://wiki.freecad.org/Macro_Express_Placement\"\n__Wiki__ = \"https://wiki.freecad.org/Macro_Express_Placement\"\n__Icon__ = \"https://wiki.freecad.org/images/8/8f/Std_AxisCross_example.svg\"\n__Help__ = \"Display and quickly edit selected object placement coordinates directly or via expressions\"\n__Status__ = \"Working\"\n__Requires__ = \"FreeCAD >= 0.19\"\n__Communication__ = \"https://forum.freecad.org/memberlist.php?mode=viewprofile&u=60629\"\n#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n\n''' ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThis macro is free software: you can redistribute it and/or modify it under the terms of the \nversion 3 GNU General Public License as published by the Free Software Foundation. \n \nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY without even \nthe implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \nSee the GNU General Public License for more details (https://www.gnu.org/licenses/gpl-3.0.html) \n \nWARNING TO USERS AND MODIFIERS \n \nThis script contains \"Buy me a coffee\" links to honor the author's hard work and dedication in creating \nall the features present in this code. Removing or altering these links not only violates the GPL license \nbut also disregards the significant effort put into making this script valuable for the community. \n \nIf you find value in this script and would like to show appreciation to the author, \nkindly consider visiting the site below and treating the author to a few cups of coffee: \n https://www.buymeacoffee.com/screeneroner \nYour honor and gratitude is greatly appreciated.\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ''' \n\n\nimport FreeCADGui as Gui\nimport FreeCAD as App\nfrom PySide import QtGui, QtCore\n\n# Define a function to create and display a table\ndef create_table():\n # Function to update the table with the selected object's data\n def update_table_with_selected_object():\n # Clear the table first\n clear_table()\n\n # Get the selected objects\n selection = Gui.Selection.getSelection()\n # If there's exactly one selected object\n if len(selection) == 1:\n selected_obj = selection[0]\n selected_object = selected_obj\n # Ensure the object isn't a spreadsheet\n if str(selected_obj.TypeId) != \"Spreadsheet::Sheet\":\n # Populate the table with the object's placement data\n populate_table_with_placement(selected_obj)\n # Store the selected object on the table widget\n table_widget.selected_object = selected_obj\n\n # Function to populate the table with an object's placement data\n def populate_table_with_placement(selected_obj):\n # Clear the table first\n clear_table() # Get the object's placement\n placement = selected_obj.Placement\n # Update each row of the table with the object's placement data\n for row in range(3): # Limit to 3 instead of row_count\n value_widget = QtGui.QTableWidgetItem()\n value_widget.setText(str(getattr(placement.Base, [\"x\", \"y\", \"z\"][row])))\n table_widget.setItem(row, 0, value_widget) # Get the object's properties\n properties_list = selected_obj.ExpressionEngine\n # If the object has properties\n if properties_list is not None:\n # For each property that involves placement\n for prop in properties_list:\n if prop[0] in [\".Placement.Base.x\", \".Placement.Base.y\", \".Placement.Base.z\"]:\n # Get the attribute's name\n attribute = prop[0].split(\".\")[-1]\n # Set the corresponding cell's value\n expression_label = QtGui.QTableWidgetItem()\n expression_label.setText(prop[1])\n table_widget.setItem([\"x\", \"y\", \"z\"].index(attribute), 1, expression_label) # Add the new row with the support data\n support_label_widget = QtGui.QLabel(\" \")\n support_link_widget = QtGui.QLabel( u'\\u2615' + ' Buy me a coffee ')\n support_link_widget.setAlignment(QtCore.Qt.AlignRight | QtCore.Qt.AlignVCenter)\n support_link_widget.setTextFormat(QtCore.Qt.RichText)\n support_link_widget.setTextInteractionFlags(QtCore.Qt.TextBrowserInteraction)\n support_link_widget.setOpenExternalLinks(True)\n \n table_widget.setCellWidget(3, 0, support_label_widget)\n table_widget.setCellWidget(3, 1, support_link_widget) # Adjust the height of each row\n header = table_widget.horizontalHeader()\n header.setFixedHeight(24) \n for row in range(row_count):\n table_widget.setRowHeight(row, 18)\n\n\n # Function to clear the table\n def clear_table():\n for row in range(row_count):\n for col in range(column_count):\n table_widget.takeItem(row, col)\n\n # Function to update the selected object's placement values based on edits to the table\n def update_values(row):\n item = table_widget.item(row, 0)\n if item is not None:\n # Get the edited text\n edited_text = item.text()\n # Get the label of the value that was edited\n value_label = [\"x\", \"y\", \"z\"][row]\n # Get the selected object\n selected_obj = table_widget.selected_object\n # Get the object's placement\n placement = selected_obj.Placement\n\n # If the edited text is not empty\n if edited_text != \"\":\n try:\n # Try to convert the edited text to a float\n edited_value = float(edited_text)\n # Update the corresponding placement value\n if value_label == \"x\":\n placement.Base.x = edited_value\n elif value_label == \"y\":\n placement.Base.y = edited_value\n elif value_label == \"z\":\n placement.Base.z = edited_value\n except ValueError:\n # If the text can't be converted to a float, print an error message\n print(\"Invalid value entered. The value must be a valid number.\")\n\n # Update the object's placement\n selected_obj.Placement = placement\n\n # Recompute the document to reflect the changes\n App.ActiveDocument.recompute()\n # print(f\"Updated value: {edited_value} in row {row}, column 0\")\n\n # Reselect the object to refresh the table data\n reselect_object(selected_obj)\n\n # Function to update the selected object's expression values based on edits to the table\n def update_expression(row):\n item = table_widget.item(row, 1)\n if item is not None:\n # Get the edited text\n edited_text = item.text()\n # Get the label of the expression that was edited\n expression_label = [\"x\", \"y\", \"z\"][row]\n # Get the selected object\n selected_obj = table_widget.selected_object\n # Get the attribute's name\n attribute = f\".Placement.Base.{expression_label}\"\n\n # Update the attribute's expression\n selected_obj.setExpression(attribute, edited_text if edited_text != \"\" else None)\n\n # Recompute the document to reflect the changes\n App.ActiveDocument.recompute()\n # print(f\"Updated expression: {edited_text} in row {row}, column 1\")\n\n # Reselect the object to refresh the table data\n reselect_object(selected_obj)\n\n # Function to reselect an object\n def reselect_object(selected_obj):\n # Clear the current selection\n Gui.Selection.clearSelection()\n # Add the selected object to the selection\n Gui.Selection.addSelection(selected_obj)\n\n # Define the table's dimensions\n row_count = 4\n column_count = 2\n\n # Create the table widget\n table_widget = QtGui.QTableWidget(row_count, column_count)\n table_widget.setHorizontalHeaderLabels([\"Value\", \"Expression\"])\n table_widget.setVerticalHeaderLabels([\"x\", \"y\", \"z\", \" \"])\n\n # Left align the headers\n header = table_widget.horizontalHeader()\n header.setDefaultAlignment(QtCore.Qt.AlignLeft)\n\n # Adjust columns to contents\n table_widget.setSizeAdjustPolicy(QtGui.QAbstractScrollArea.AdjustToContents)\n table_widget.resizeColumnsToContents()\n table_widget.resizeRowsToContents()\n\n table_widget.setShowGrid(False)\n\n # Assign a delegate to handle cell edits\n delegate = QtGui.QItemDelegate()\n table_widget.setItemDelegate(delegate)\n\n # Connect signals to handle cell edits\n delegate.commitData.connect(lambda: update_values(table_widget.currentRow()) if table_widget.currentColumn() == 0 else None)\n delegate.closeEditor.connect(\n lambda: update_expression(table_widget.currentRow()) if table_widget.currentColumn() == 1 else None\n )\n\n # Define a class to observe selection changes\n class SelectionObserver:\n # When an object is selected, update the table\n def addSelection(self, doc, obj, sub, pnt):\n update_table_with_selected_object()\n\n # When an object is deselected, update the table\n def removeSelection(self, doc, obj, sub):\n update_table_with_selected_object()\n\n # Create an instance of the observer class\n selection_observer = SelectionObserver()\n # Add the observer to the selection\n Gui.Selection.addObserver(selection_observer)\n\n # Update the table with the currently selected object's data\n update_table_with_selected_object()\n\n # Make the last column stretch to fill the remaining space\n table_widget.horizontalHeader().setStretchLastSection(True)\n\n # Get the main window\n mainWindow = Gui.getMainWindow()\n\n # Check if the dock widget already exists\n dock_widget = mainWindow.findChild(QtGui.QDockWidget, \"ExpressPlacementWidget\")\n\n # If the dock widget does not exist, create it\n if dock_widget is None:\n dock_widget = QtGui.QDockWidget(\"Express Placement\")\n dock_widget.setObjectName(\"ExpressPlacementWidget\") # Assign an object name to the dock widget\n mainWindow.addDockWidget(QtCore.Qt.LeftDockWidgetArea, dock_widget)\n\n # Set the dock widget's widget to the table\n dock_widget.setWidget(table_widget)\n # Make sure the dock widget is visible\n dock_widget.setVisible(True)\n\n# Create and display the table\ncreate_table()\n\n}}\n\n\n
\n\n\n---\n⏵ [documentation index](../README.md) > Macro Express Placement\n"} {"id": "freecad-docs:wiki/Macro_FCCamera.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_FCCamera.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_FCCamera.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d34a6f088fb7392933297e088a991f4879973d90d8eab44d65996041e39470b6", "bytes": 8914, "tokens": 3186, "text": "# Macro FCCamera\n{{Macro\n|Name=Macro FCCamera\n|Icon=FCCamera_00.png\n|Description=This macro can rotate the screen in a defined angle and the defined axis and creates a plan to face the screen to create a form in the specified plan positions the selected face facing the screen, to detect the position of the camera, align view to face or to axis, align the object to view.\n|Author=Mario52\n|Version=0.15b\n|Date=2024/12/19\n|FCVersion=1.00 and more\n|Download=[https://wiki.freecad.org/images/2/25/FCCamera_00.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro can rotate the screen in a defined angle and the defined axis and creates a plan to face the screen to create a form in the specified plan positions the selected face facing the screen, to detect the position of the camera, align view to face or to axis, align the object to view.\n\n \n\n## Usage\n\n\"FCCamera\"\n\n**Camera of Axis**: The dialog box to enter the rotation value angle in degrees.\n\n**Angle rotation Axis in degrees**: Select the rotation axis **X**, **Y** or **Z**.\n\n**Axe of rotation**\n\n- \"\" **Accept the rotation** : Accept the rotation give to angle selected\n\n**Virtual**\n\n- \"\" **Detect camera orientation** : Detect the camera orientation and print in report view. The returned value is the value provided by the function **getCameraOrientation()**.\n\n**Align view to face selected**\n\n- \"\" **To Face.** : Align the view to the selected face. Click and repeat the click for **NormalAt** : \\\"(0,0,1) (0,0,-1) (0,1,0) (0,-1,0) (1,0,0) (-1,0,0)\\\"\n\n- \"\" **To Axis.** : Align the view to Axis face selected. Click and repeat the click for **Surface Axis** : \\\"(0,0,1) (0,0,-1) (0,1,0) (0,-1,0) (1,0,0) (-1,0,0)\\\"\n\n- \"\" **Align object to view.** : Align the object selected to the actual view. The changed values are : Rotation Axis((X, Y, Z), Angle), same Euler angles : Yaw, Pitch, Roll, The Translation is not modify.\n\n- \"\" **Create plane of view.** : A circular plane is created facing the screen to mouse click coordinates on an object. The radius of the plane is equal to the maximum dimension of BoundBox. If no object is selected, the plane is created to 0, 0, 0 coordinates with a radius of 20 mm. The radius is modifiable to line 515:\n\n \n```python\n rayon = 20 # Radius of plane\n```\n\n- **[ Reset.**: Reset all values\n\n- ** [ Photo.**: Section save the screen rotation an image in angle value\n\n- ** [ Quit.**: Quit FCCamera\n\n\n## Section Photo \n\n\"FCCamera\" \n\n- **ComboBox Actual **: Choose your screen definition for the image format\n\n - Available (pre-defined):\n - \\\"Actual\\\" (definition actual of screen)\n - \\\"Icon 16 x 16\\\"\n - \\\"Icon 32 x 32\\\"\n - \\\"Icon 64 x 64\\\"\n - \\\"Icon 128 x 128\\\"\n - \\\"CGA 320 x 200\\\"\n - \\\"QVGA 320 x 240\\\"\n - \\\"VGA 640 x 480\\\"\n - \\\"SVGA 800 x 600\\\"\n - \\\"XGA 1024 x 768\\\"\n - \\\"XGA+ 1152 x 864\\\"\n - \\\"SXGA 1280 x 1024\\\"\n - \\\"SXGA+ 1400 x 1050\\\"\n - \\\"UXGA 1600 x 1200\\\"\n - \\\"QXGA 2048 x 1536\\\"\n - \\\"Free\\\"\n\n- **SpinBox X and Y **\n \n\n- **ComboBox Format image**- Available :\n - \\\"BMP \\*.bmp\\\"\n - \\\"ICO \\*.ico\\\"\n - \\\"JPEG \\*.jpeg\\\"\n - \\\"JPG \\*.jpg\\\"\n - \\\"PNG \\*.png\\\" (by default)\n - \\\"PPM \\*.ppm\\\"\n - \\\"TIF \\*.tif\\\"\n - \\\"TIFF \\*.tiff\\\"\n - \\\"XBM \\*.xbm\\\"\n - \\\"XPM \\*.xpm\\\"\n\n- Line 1 : Number image calculated by the angle give (ex: angle 60 degrees = 360 (complete rotation) / 60 (angle) = 6 images\n\n- Line 2 : The definition of screen used\n\n- Background image :\n - Actual : save image with the screen colour actual\n - White : save image with the screen colour white\n - Black : save image with the screen colour black\n\n- **[ Launch**: Open the file window , give the name and the path\n\n- **[ Reset**: Reset the default value\n\n- **[ Return**: Quit the photo panel and return to FCCamera panel\n\n\n## Links\n\nRelated Links with FCCamera\n\n- [Macro Rotate View](Macro_Rotate_View.md)\n- [Macro Align Object to View](Macro_Align_Object_to_View.md)\n- [Macro Align Face Object to View](Macro_Align_Face_Object_to_View.md)\n- [Macro WorkFeatures](Macro_WorkFeatures.md)\n\nDiscussion Forum [MACRO:Work Feature 2014_12](http://forum.freecadweb.org/viewtopic.php?f=22&t=9056)\n\n## Script\n\nDownload the icon files [FCCamera_Icones.zip](https://forum.freecadweb.org/download/file.php?id=79288)\n\nDownload the macro to Gist [**Macro FCCamera.FCMacro**](https://gist.github.com/mario52a/4aa545c23b323cf68824)\n\n## Examples\n\n### How to place an angle hole \n\n\n
\n\n 09.png\\|Create your object 10.png\\|Create one cylinder and positionning like this.\nGive your axis, angle inclination and click the button \"\" \n**Accept the rotation**\n\n\n
\n\n\n
\n\n 11.png\\|Select your cylinder for create your hole 12.png\\|In FCCamera, click the button \"\" \n**Align Object to View**\n\n\n
\n\n\n
\n\n 13.png\\|The cylinder moves to 15 degrees (it takes the camera\\'s position). Do your Boolean operation 14.png\\|Your hole 15 degrees\n\n\n
\n\nThe same result can be achieved by creating a plan in the corner given by the mouse click position and a sketch.\n\n\n
\n\n of the positioning of a spring on an axis of a face\n\n\n
\n\n\n
\n\n photo rotation and save images (you must create one animate Gif [with GIMP](https://www.gimp.org/))\n\n\n
\n\n\n## Version\n\n- **ver 0.15, 0.15b (19/12/2024):** adapt and return PySide, ([FCCamera macro can\\'t find Pyside2](https://forum.freecad.org/viewtopic.php?p=797838)) correct the web access delete **WebGui** replaced by **webbrowser**\n\n \n```python\n####\ntry:\n import webbrowser\n webbrowser.open(\"http://www.freecadweb.org/wiki/index.php?title=Macro_FCCamera\")\nexcept Exception:\n None\n####\n####\nimport urllib\nfrom urllib import request\n\ncontentPage = request.urlopen(\"https://wiki.freecadweb.org/Macro_FCCamera\").readlines()\n####\n```\n\n- **ver 0.14 (20/10/2020) :** \\*correction bug \\\"Grid\\\" not accepted\n\n- **ver 0.13 (28/06/2020):** adding files image in source code, create plane \\\"On point, Center face, BBox center, Center Mass\\\", gridLayout\n\n- **ver 00.12.1 (12/02/2020):** suppress the bad character lines 674 and 675 (accent\\...) again\n\n- **ver 12 (01/08/2019):** compatible Python 3 ( print to print() )\n\n- **ver 11 (13/01/2018):** minor\n\n- **ver 10 (13/01/2018):** add \\\"def centerBoundBoxGlobal():\\\"\n\n- **ver 09 (08/01/2018):** minor\n\n- **ver 08 (08/01/2018):** supp \\\"Pyqt4\\\" and adjust number image\n- **ver 07 (03/01/2018):** add photo panel and rotation to axis selected (wire, edge, line )\n\n- **ver 0.6 (13/12/2016):** new system for search the macro path directly in the preferences\n\n \n```python\n#path = FreeCAD.ConfigGet(\"AppHomePath\")\n#path = FreeCAD.ConfigGet(\"UserAppData\")\n#path = \"your path\"\nparam = FreeCAD.ParamGet(\"User parameter:BaseApp/Preferences/Macro\")# macro path\npath = param.GetString(\"MacroPath\",\"\") + \"/\" # macro path\npath = path.replace(\"\\\\\",\"/\")\nApp.Console.PrintMessage(\"Path locality to FCCamera.....images.png [ \" + path + \" ]\"+\"\\n\")\n```\n\n- **ver 0.5 06/09/2016:** correct name \\\"FCCamera_Axis_rotation_X.png\\\" in reset block\n\n- **ver 0.4 28/02/2016 :** add display all camera detection and the [Direction](http://forum.freecadweb.org/viewtopic.php?f=13&t=14213#p114667)\n\n- **ver 0.3 18/03/2015 :** modify line 492 replace \\\"**pl.Base = App.Vector(0,0,0)**\\\" to \\\"**pl.Base = sel\\[0\\].Placement.Base**\\\" now no longer moves the form at point (0,0,0) and leaves has the coordinates\n\n- **ver 0.2 25/02/2015 :** correct names files in for compatibility Linux (case sensitive) thanks microelly2\n\n\n---\n⏵ [documentation index](../README.md) > Macro FCCamera\n"} {"id": "freecad-docs:wiki/Macro_GuiResetToolbars.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_GuiResetToolbars.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_GuiResetToolbars.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "242e8203c5e24e747998ff24a743622439f0205115754281d81b9144dda2930d", "bytes": 2529, "tokens": 1019, "text": "# Macro GuiResetToolbars\n{{Macro\n|Name=GuiResetToolbars\n|Description=This macro resets the position of the toolbars. Run the macro within a workbench that has a missing toolbar(s).\n|Author=PR-DC\n|Download=[https://wiki.freecad.org/images/f/f8/GuiResetToolbars.svg ToolBar Icon]\n|Date=2020-04-21\n|Version=1.0.0\n|FCVersion= 0.18.4 and above\n|SeeAlso=[https://github.com/PR-DC/GuiResetToolbars/ Github repository]\n}}\n\n## Description\n\nThis macro resets the position of the toolbars.\n\n## Usage\n\nRun the macro within a workbench that has a missing toolbar(s).\n\n## Script\n\nToolBar Icon ![](images/GuiResetToolbars.svg )\n\n**GuiResetToolbars.FCMacro**\n\n\n{{MacroCode|code=\n# Reset Toolbars position\n# Author: Milos Petrasinovic \n# PR-DC, Republic of Serbia\n# info@pr-dc.com\n# \n# \n#\n# Copyright (C) 2020 PR-DC \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 as \n# published by the Free Software Foundation, either version 3 of the \n# License, or (at your option) any later version.\n# \n# This program 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 Lesser General Public License for more details.\n# \n# You should have received a copy of the GNU Lesser General Public License\n# along with this program. If not, see .\n#\n# \n\n__Name__ = 'GuiResetToolbars'\n__Comment__ = 'Reset Toolbars position'\n__Author__ = 'PR-DC'\n__Version__ = '1.0.0'\n__Date__ = '2020-04-21'\n__License__ = 'LGPL-3.0-or-later'\n__Web__ = \"https://github.com/PR-DC/GuiResetToolbars/\"\n__Wiki__ = 'https://wiki.freecadweb.org/Macro_GuiResetToolbars'\n__Icon__ = 'https://wiki.freecad.org/images/f/f8/GuiResetToolbars.svg'\n__Help__ = 'Run the macro within a workbench that has missing toolbar(s)'\n__Status__ = 'stable'\n__Requires__ = 'Freecad >= 0.18.4'\n__Communication__ = 'https://github.com/PR-DC/GuiResetToolbars/issues/'\n__Files__ = 'GuiResetToolbars.svg'\n\nimport FreeCADGui as gui\nfrom PySide import QtGui, QtCore # FreeCAD's special PySide!\n\nmw = gui.getMainWindow()\ntb = mw.findChildren(QtGui.QToolBar)\nfor i in tb:\n mw.addToolBar(QtCore.Qt.TopToolBarArea, i)\n}}\n\n\n## Links\n\nThe forum discussion [Reset toolbar position](https://forum.freecadweb.org/viewtopic.php?f=3&t=45452&p=390034#p389404)\n\n\n---\n⏵ [documentation index](../README.md) > Macro GuiResetToolbars\n"} {"id": "freecad-docs:wiki/Macro_HighlightCommon.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_HighlightCommon.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_HighlightCommon.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "defcb2e902b920b472c82b7ca53c98655d287b60408ab196588a2a5895c9e804", "bytes": 1357, "tokens": 459, "text": "# Macro HighlightCommon\n{{Macro\n|Name=HightlightCommon\n|Icon=Macro_HighlightCommon.png\n|Description=Highlight common parts by showing the common shape in red and setting half-transparency on original parts (the original objects are not modified)\n|Author=JMG\n|Version=2.3.2\n|Date=2021-07-01\n|FCVersion=0.17 and above\n|Download=[https://wiki.freecad.org/images/8/85/Macro_HighlightCommon.png ToolBar Icon]\n}}\n\n## Description\n\nHighlight common parts by showing the common shape in red and setting half-transparency on original parts (the original objects are not modified)\n\n \n\n![](images/Captura_de_pantalla_de_2015-09-10_11-17-30.png ) \n*Volume common of objects selected*\n\n## Script\n\nToolBar Icon ![](images/Macro_HighlightCommon.png )\n\n**Macro_HighlightCommon.FCMacro**\n\nThe code is visible on Github: [Utility/HighlightCommon.FCMacro](https://github.com/FreeCAD/FreeCAD-macros/blob/master/Utility/HighlightCommon.FCMacro).\n\n## Links\n\n- See for the complementary macro [Macro_HighlightDifference](Macro_HighlightDifference.md)\n- My blog [Linux for an engineer](http://linuxforanengineer.blogspot.com.es/) for the code and other interesting macros for FreeCAD\n- The discussion on forum [\\\"collision detection\\\", overlapping](http://forum.freecadweb.org/viewtopic.php?f=22&t=12426)\n\n\n---\n⏵ [documentation index](../README.md) > Macro HighlightCommon\n"} {"id": "freecad-docs:wiki/Macro_Toggle_Panels_Visibility.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Toggle_Panels_Visibility.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Toggle_Panels_Visibility.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9c6a8dc96ad6d031ae46282c0520b69a2ec9669aeb882d39dea3b42c3b3b1ef0", "bytes": 2502, "tokens": 787, "text": "# Macro Toggle Panels Visibility\n{{Macro\n|Name=Macro Toggle Panels Visibility\n|Icon=Macro_Toggle_Views_Visibility.png\n|Description=This macro toggles the visibility of various supporting views in FreeCAD, allowing the main window to be viewed with all available screen space.\n|Author=Piffpoof\n|Version=1.0\n|Date=2015-01-17\n|FCVersion=All\n|Download=[https://wiki.freecad.org/images/d/d0/Macro_Toggle_Views_Visibility.png ToolBar Icon]\n|SeeAlso=[https://forum.freecadweb.org/viewtopic.php?f=22&t=30450&hilit=Toggle_Panels Toggle Panels]\n}}\n\n## Description\n\nWhen working with FreeCAD there are times when you need many supporting windows open, such as Combo View, Report View, etc. There are other times when you want all the clutter of the supporting windows to disappear so that all the screen space available can be used to view the model being worked with. This macro lets you hide all the supporting windows (or make them visible again) with one click on the toolbar.\n\n## Installation\n\nSave the provided code to the appropriate Macro directory and execute it from the Macro menu. It is preferable to add it to a toolbar for ease of access.\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\nClick on the associated toolbar button, or invoke from the Macro menu. The supporting windows Python console, Report view, Combo view will either all become visible or all become hidden.\n\n## User Interface \n\nThere is immediate confirmation of the user action as the supporting windows either appear or disappear.\n\n## Scripts\n\nToolbar icon ![](images/Macro_Toggle_Views_Visibility.png )\n\n **Macro_Toggle_Panels_Visibility.FCMacro**\n\n\n{{MacroCode|code=\n# -*- coding: utf-8 -*-\n# macro to toggle visibility of Report view, Python console, Combo view\nfrom PySide import QtCore, QtGui\nmainWindow = FreeCADGui.getMainWindow()\ndockWidgets = mainWindow.findChildren(QtGui.QDockWidget)\nfor dw in dockWidgets:\n if dw.objectName() == \"Python console\":\n pcWidget = dw\n if dw.objectName() == \"Combo View\":\n cvWidget = dw\n if dw.objectName() == \"Report view\":\n rvWidget = dw\n \nif pcWidget.isVisible():\n pcWidget.hide()\n cvWidget.hide()\n rvWidget.hide()\nelse:\n pcWidget.show()\n cvWidget.show()\n rvWidget.show()\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Macro Toggle Panels Visibility\n"} {"id": "freecad-docs:wiki/Macro_Toggle_Visibility.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Toggle_Visibility.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Toggle_Visibility.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "cd16b9aa5e34fe7d968cee36d2d56bac715e242d4ca4ffb514c8fdcdb34c7f74", "bytes": 4024, "tokens": 1233, "text": "# Macro Toggle Visibility\n{{Macro\n|Name=Toggle Visibility\n|Icon=Macro SelectVisible.png\n|Description=Toggling Hidden/Display all objects not selected.
objects that are selected in a document are made visible while objects that are not selected are made invisible.
if no objects are selected then all objects are hidden.
if all objects are selected then all objects are made visible.\n|Author=Mario52\n|Version=00.02\n|Date=2015-11-12\n|FCVersion=All\n|Download=[https://www.freecadweb.org/wiki/images/4/42/Macro_SelectVisible.png ToolBar Icon]\n|SeeAlso=[Macro Toggle Visibility2 1-2](Macro_Toggle_Visibility2_1-2.md)
[Macro Toggle Visibility2 2-2](Macro_Toggle_Visibility2_2-2.md)
[Macro VisibleAlls](Macro_VisibleAlls.md)
[Macro HiddenAlls](Macro_HiddenAlls.md)
[Macro If Selected Stay If Not Then Delete](Macro_If_Selected_Stay_If_Not_Then_Delete.md)\n}}\n\n## Description\n\nObjects that are selected in a document are made visible while objects that are not selected are made invisible.\n\n- if no objects are selected then all objects are hidden\n- if all objects are selected then all objects are made visible\n\n## How To Use \n\nCopy the macro and the icon in your folder macros and run (see [How to install macros](How_to_install_macros.md))\n\n## Toggle Visibility \n\nUsing the selection of objects in the one of the FreeCAD views, this macro makes all selected objects visible and hides all objects which are not selected.\n\nIf no object(s) are selected then all objects are hidden.\n\nIf all objects are hidden and there is no selection in ComboView then all object are made visible.\n\nThis version new version (00.02) include the tree macro in one.\n\n## Script\n\nThe macro icon \"\"\n\n **Macro_ToggleSelectedObjectVisibility.FCMacro**\n\n\n{{MacroCode|code=\n\nimport FreeCAD\n# Macro_ToggleSelectedObjectVisibility\n__title__=\"Macro_ToggleSelectedObjectVisibility\"\n__author__ = \"Mario52\"\n__url__ = \"http://www.freecadweb.org/index-fr.html\"\n__version__ = \"00.02\"\n__date__ = \"12/11/2015\"\n\ntry:\n compt = 0\n for ShapeNameObj in FreeCAD.ActiveDocument.Objects: # list alls objet for test if alls hidden\n if (FreeCADGui.ActiveDocument.getObject(ShapeNameObj.Name).Visibility == False) and (Gui.Selection.isSelected(ShapeNameObj) == False):\n compt += 1 # if hidden : compt += 1\n #print \"False : \",ShapeNameObj.Name\n if compt == len(FreeCAD.ActiveDocument.Objects): # if (compt = Alls objects hidden) then Visibility = True\n for ShapeNameObj in FreeCAD.ActiveDocument.Objects:\n FreeCADGui.ActiveDocument.getObject(ShapeNameObj.Name).Visibility = True # Visibility = True\n #print \"True : \",ShapeNameObj.Name\n compt = 0\n else :\n for ShapeNameObj in FreeCAD.ActiveDocument.Objects: # hidde objects not selecteds\n if Gui.Selection.isSelected(ShapeNameObj) == False:\n FreeCADGui.ActiveDocument.getObject(ShapeNameObj.Name).Visibility = False # if objects is not selected then Visibility = False (Hidden)\n #print \"False : \",ShapeNameObj.Name\n else:\n FreeCADGui.ActiveDocument.getObject(ShapeNameObj.Name).Visibility = True # if objects are hidden and selected then Visibility = True and hidden alls objects visibles\n #print \"True : \",ShapeNameObj.Name\nexcept Exception:\n None\n}}\n\n\n## Link\n\nThe discussion on the forum [Proposal: select one or more pieces, hide the others.](http://forum.freecadweb.org/viewtopic.php?f=8&t=13152)\n\n## Version\n\nver 00.02 12/11/2015 **macro Macro_SelectVisible** : hidden the objects not selected, if not object selected displayed all objects, hidden all objects. This version include the tree macro in one\n\n\n---\n⏵ [documentation index](../README.md) > Macro Toggle Visibility\n"} {"id": "freecad-docs:wiki/Macro_Triangle_AH.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_Triangle_AH.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_Triangle_AH.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "230c43591fc4a14b83a50cc503d7f2cc7e9219c8c6021b98d8a9b56573c378f2", "bytes": 3545, "tokens": 1257, "text": "# Macro Triangle AH\n{{Macro\n|Name=Macro Triangle AH\n|Description=This macro create one triangle creates a triangle by giving the head angle and the height of the triangle. The new triangle is created in the real coordinate.
{{ColoredText|(Command line, paste this complete macro in the Python console)}}.\n|Author=mario52\n|Version=00.03\n|Date=2019/07/02\n|FCVersion=All\n|Download=[https://wiki.freecad.org/images/4/41/Macro_Triangle_AH.png ToolBar Icon]\n}}\n\n## Description\n\nThis macro create one isosceles triangle by giving the head angle and the height of the triangle. The triangle of the head is positioned to the xyz coordinates 0.0.0.\n\n## Usage\n\nCopy the macro **Triangle AH** complete in the Python console FreeCAD\n\n## Script\n\nToolBar Icon ![](images/Macro_Triangle_AH.png )\n\n **Macro_triangleAH.FCMacro**\n\n\n{{MacroCode|code=\n__title__ = \"triangleAH\"\n__author__ = \"Mario52\"\n__version__ = \"00.03\"\n__date__ = \"2019/07/02\"\n# Give angle and on choice : height or base or hypo\nfrom math import cos, sin, tan, degrees, radians, sqrt\nimport Draft, Part\ndef triangleAH(angle, height=0.0, base=0.0, hypo=0.0):\n def line_length(x1 = 0.0, y1 = 0.0, z1 = 0.0, length = 10.0, angle2 = 0.0): # search coordinates\n x2 = x1 + (length * cos(radians(angle2)))\n y2 = y1 + (length * sin(radians(angle2)))\n z2 = z1 #+ ()\n return x2,y2,z2 # return coordinates (xyz) to point\n \n x0 = y0 = z0 = 0.0\n angle = float(angle)\n height = float(height)\n base = float(base)\n if base != 0:\n height = ( (base/2) / (tan(radians(angle/2))) ) # imposing base and calculate height\n if hypo != 0:\n height = hypo * (cos(radians(angle/2))) # imposing hypo and calculate height \n else:\n hypo = height / cos(radians(angle/2)) # calculate hypotenuse\n if base==0: # base of triangle\n base = (tan(radians(angle/2) ) * height) * 2 # calculate base\n a0 = line_length(x1=x0,y1=y0,z1=z0,length=height,angle2=0 ) # coord height of triangle\n a0 = line_length(x1=x0,y1=y0,z1=z0,length=0, angle2 = angle ) # point 0 (begin vertex)\n a = line_length(x1=a0[0],y1=a0[1],z1=a0[2],length= hypo, angle2=-(angle/2)) #\n b = line_length(a[0],a[1],a[2],length= (abs(a[1])*2), angle2=90.0) # base of triangle = (abs(a[1])*2)\n ##\n print()\n print(\"angle theet : \", angle)\n print(\"angles base : (\", (180.0-angle)/2.0,\"),(\",(180-angle)/2.0,\")\")\n print(\"height : \", height)\n print(\"base : \", base)\n print(\"hypotenuse : \", hypo)\n print(\"surface : \", (base * height) / 2.0)\n print(\"_________________________\")\n Draft.makeWire([FreeCAD.Vector(a0),FreeCAD.Vector(a),FreeCAD.Vector(b)],closed=True,face=True,support=None) # create triangle\n App.ActiveDocument.recompute()\n\n#Example\n#triangleAH(angle=90, height=10)\n#triangleAH(90, 10)\n#triangleAH(45, hypo=10)\n\n\n}}\n\n\n## Example\n\n \n```python\ntriangleAH(angle=90, height=10)\n# or\ntriangleAH(90, 10)\n# or\ntriangleAH(45, hypo=10)\n# or\ntriangleAH(90, base=10)\n```\n\n## Version\n\nver 00.03 2019/07/02 add \\\"App.ActiveDocument.recompute()\\\" and convert Py3\n\nver 00.02 03/05/2015 : adding \\\"base=0.0\\\", \\\"hypo=0.0\\\" and print data of triangle\n\nver 00.01 20/03/2015 :\n\n\n---\n⏵ [documentation index](../README.md) > Macro Triangle AH\n"} {"id": "freecad-docs:wiki/Macro_View_Rotation.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Macro_View_Rotation.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Macro_View_Rotation.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a589ad4408d24da249bdb5b9e021db32675763228f9749eaa5104b5e44874ccc", "bytes": 10656, "tokens": 3414, "text": "# Macro View Rotation\n{{Macro\n|Name=Macro View Rotation\n|Icon=Macro_View_Rotation.png\n|Description=This GUI allows the view to be rotated with more precision than when using the mouse. Rotation is according to axes fixed with respect to the user and not the objects, though the aim is that the objects rotate about their approximate shared centre rather than the view centre.
\nThe GUI defaults to the top right of the screen, this behaviour can be changed by editing.
\n
\n[http://forum.freecadweb.org/download/file.php?id=453 Icons Package]\n|Author=Joe Dowsett\n|Version=1.0\n|Date=2012-01-04\n|FCVersion=All\n|Download=[https://wiki.freecad.org/images/a/af/Macro_View_Rotation.png ToolBar Icon]\n|SeeAlso=[Macro Rotate View](Macro_Rotate_View.md), [Macro FCCamera](Macro_FCCamera.md)\n}}\n\n## Description\n\nThis GUI allows the view to be rotated with more precision than when using the mouse. Rotation is according to axes fixed with respect to the user and not the objects, though the aim is that the objects rotate about their approximate shared centre rather than the view centre.\n\nThe GUI defaults to the top right of the screen, this behaviour can be changed by editing.\n\n \n\n\"Rotate Three icons are referred to symbolise the rotation directions. A zip file containing these icons can be found [here](http://forum.freecadweb.org/download/file.php?id=453), the images should be placed in the folder containing your macros. Please feel free to contribute better ones!\n\n## Script\n\nThe latest version of the macro is to be found at [ViewRotation.FCMacro](https://github.com/FreeCAD/FreeCAD-macros/blob/master/PureGui/ViewRotation.FCMacro) but the easiest way to install this macro is through the [Addon Manager](Std_AddonMgr.md).\n\nToolBar Icon ![](images/Macro_View_Rotation.png )\n\n **Macro View Rotation.FCMacro** {{MacroCode|code=\n# -*- coding: utf-8 -*-\n#\n# FreeCAD macro ViewRotation.\n# This GUI allows the view to be rotated with more precision than when using\n# the mouse. Rotation is according to axes fixed with respect to the user and\n# not the objects, though the aim is that the objects rotate about their\n# approximate shared centre rather than the view centre.\n# The GUI defaults to the top right of the screen, this behaviour can be\n# changed by editing.\n# [http://forum.freecadweb.org/viewtopic.php?f=3&t=1784&hilit=View+Rotation#p12012 View+Rotation]\n\nfrom __future__ import division\n\n__Name__ = 'View Rotation'\n__Comment__ = 'This GUI allows the view to be rotated precisely'\n__Author__ = 'Joe Dowsett'\n__Version__ = '1.0'\n__License__ = 'CC-BY-3.0'\n__Web__ = 'https://www.freecadweb.org/wiki/Macro_View_Rotation'\n__Wiki__ = 'https://www.freecadweb.org/wiki/Macro_View_Rotation'\n__Icon__ = ''\n__Help__ = 'Rotation is according to axes fixed with respect to the user.'\n__Status__ = ''\n__Requires__ = ''\n__Files__ = 'ViewRotationOut.png,ViewRotationRight.png,ViewRotationUp.png'\n\nfrom math import pi\nimport os\n\nfrom PySide import QtCore\nfrom PySide import QtGui\nfrom pivy import coin\n\nimport FreeCAD as app\nimport FreeCADGui as gui\n\n\ndef get_macro_dir():\n \"\"\"Return the directory where macros are located\"\"\"\n default_macro_dir = os.path.join(app.ConfigGet('UserAppData'), 'Macro')\n return app.ParamGet('User parameter:BaseApp/Preferences/Macro').GetString('MacroPath', default_macro_dir)\n\n\ndef find_centre():\n doc = app.activeDocument()\n if doc is None:\n return app.Vector(0, 0, 0)\n\n xmax = 0\n xmin = 0\n ymax = 0\n ymin = 0\n zmax = 0\n zmin = 0\n for obj in doc.Objects:\n try:\n if obj.TypeId[:4] == 'Mesh':\n box = obj.Mesh.BoundBox\n elif obj.TypeId[:6] == 'Points':\n box = obj.Points.BoundBox\n elif obj.TypeId[:4] == 'Part':\n box = obj.Shape.BoundBox\n else:\n continue\n except AttributeError:\n continue\n xmax = max(xmax, box.XMax)\n xmin = min(xmin, box.XMin)\n ymax = max(ymax, box.YMax)\n ymin = min(ymin, box.YMin)\n zmax = max(zmax, box.ZMax)\n zmin = min(zmin, box.ZMin)\n\n return app.Vector((xmax + xmin) / 2, (ymax + ymin) / 2, (zmax + zmin) / 2)\n\n\nclass RotateGui(QtGui.QWidget):\n def __init__(self):\n super(RotateGui, self).__init__()\n self.init_ui()\n self.init_rotate()\n\n def init_ui(self):\n macro_dir = get_macro_dir()\n self.sliders = []\n self.line_edits = []\n\n vbox = QtGui.QVBoxLayout()\n\n icons = ('ViewRotationRight.png', 'ViewRotationUp.png', 'ViewRotationOut.png')\n for icon in icons:\n slider = QtGui.QSlider(QtCore.Qt.Horizontal, self)\n slider.setFocusPolicy(QtCore.Qt.NoFocus)\n slider.setSingleStep(5)\n slider.setPageStep(15)\n slider.setValue(0)\n slider.setMaximum(180)\n slider.setMinimum(-180)\n slider.valueChanged[int].connect(self.valueChange)\n self.sliders.append(slider)\n\n line_edit = QtGui.QLineEdit(self)\n line_edit.setText('0')\n line_edit.setAlignment(QtCore.Qt.AlignRight)\n line_edit.returnPressed.connect(self.valueEntered)\n self.line_edits.append(line_edit)\n\n label = QtGui.QLabel(self)\n label.setPixmap(QtGui.QPixmap(os.path.join(macro_dir, icon)))\n\n hbox = QtGui.QHBoxLayout()\n hbox.addWidget(label, 1, QtCore.Qt.AlignCenter)\n hbox.addWidget(slider, 4)\n hbox.addWidget(line_edit, 1)\n vbox.addLayout(hbox)\n\n reset_button = QtGui.QPushButton('Reset')\n reset_button.clicked.connect(self.reset)\n\n ok_button = QtGui.QPushButton('OK')\n ok_button.clicked.connect(self.close)\n\n cancel_button = QtGui.QPushButton('Cancel')\n cancel_button.clicked.connect(self.cancel)\n\n hbox = QtGui.QHBoxLayout()\n hbox.addWidget(reset_button, 1)\n hbox.addWidget(ok_button, 1)\n hbox.addWidget(cancel_button, 1)\n vbox.addStretch(1)\n vbox.addLayout(hbox)\n\n self.setLayout(vbox)\n\n desktop_widget = QtGui.QDesktopWidget()\n right = desktop_widget.availableGeometry().width()\n\n self.setGeometry(right - 300, 0, 300, 150)\n self.setWindowTitle('Rotate view')\n self.show()\n\n def init_rotate(self):\n self.internal = False\n self.current = 0\n\n self.cam = gui.activeDocument().ActiveView.getCameraNode()\n self.centre = coin.SbVec3f(find_centre())\n self.view = self.cam.orientation.getValue()\n self.pos = self.cam.position.getValue()\n\n # Store a copy of the original view to be restored in the case of user\n # selecting Reset or Cancel.\n self.original_view = coin.SbRotation(self.view.getValue())\n self.original_pos = coin.SbVec3f(self.pos.getValue())\n\n self.config_direction(0)\n\n\n def reset(self):\n # Reset the view to the original one.\n self.cam.orientation = self.original_view\n self.cam.position = self.original_pos\n self.internal = True\n for sld in self.sliders:\n sld.setValue(0)\n self.internal = False\n for tbox in self.line_edits:\n tbox.setText(\"0\")\n self.config_direction(0)\n\n def cancel(self):\n self.reset()\n self.close()\n\n\n def config_direction(self, i):\n # Evaluate the vectors corresponding to the three directions for the\n # current view, and assign the i-th one to self.direction.\n self.view = self.cam.orientation.getValue()\n self.view = coin.SbRotation(self.view.getValue())\n self.pos = self.cam.position.getValue()\n self.pos = coin.SbVec3f(self.pos.getValue())\n\n up = coin.SbVec3f(0,1,0)\n self.up = self.view.multVec(up)\n out = coin.SbVec3f(0,0,1)\n self.out = self.view.multVec(out)\n u = self.up.getValue()\n o = self.out.getValue()\n r = (u[1]*o[2]-u[2]*o[1], u[2]*o[0]-u[0]*o[2], u[0]*o[1]-u[1]*o[0])\n self.right = coin.SbVec3f(r)\n\n self.direction = [self.right, self.up, self.out][i]\n\n def check(self, i):\n # Check if the direction of rotation has changed, if so then set\n # previous slider & textbox to zero, and setup the new direction.\n if i != self.current:\n self.internal = True\n self.sliders[self.current].setValue(0)\n self.line_edits[self.current].setText(\"0\")\n self.internal = False\n self.current = i\n self.config_direction(i)\n\n def rotate(self, value):\n # Carry out the desired rotation about self.direction.\n val = value*pi/180.0\n rot = coin.SbRotation(self.direction, -val)\n nrot = self.view*rot\n prot = rot.multVec(self.pos - self.centre) + self.centre\n self.cam.orientation = nrot\n self.cam.position = prot\n\n def valueChange(self, value):\n # Respond to the change in value of a slider, update the corresponding\n # text box, check for a direction change then rotate\n # if the value was changed internally, ignore event.\n if self.internal:\n return\n\n sender = self.sender()\n for i in range(3):\n if sender == self.sliders[i]:\n break\n self.line_edits[i].setText(str(value))\n self.check(i)\n self.rotate(value)\n\n def valueEntered(self):\n # Respond to a value being entered in a text box, updating the\n # corresponding slider, check for direction change then rotate.\n sender = self.sender()\n for i in range(3):\n if sender == self.line_edits[i]:\n break\n value = int(self.line_edits[i].text())\n self.internal = True\n self.sliders[i].setValue(value)\n self.internal = False\n self.check(i)\n self.rotate(value)\n\nif __name__ == '__main__':\n # We need to set a variable, otherwise, the dialog doesn't appear.\n rotate = RotateGui()\n\n}}\n\n\n## Option\n\nAt the end of the function \\'initUI\\' the first two arguments (right-300, 0) (line 91) provide the position for the top left corner of the window - my experience is that the behaviour was as intended on Ubuntu but Vista positioned the window too high and the 0 needed to be changed to \\~30.\n\n \n```python\n self.setGeometry(right-300, 0, 300, 150)\n```\n\n## Forum\n\n[View+Rotation](http://forum.freecadweb.org/viewtopic.php?f=3&t=1784&hilit=View+Rotation#p12012)\n\n\n---\n⏵ [documentation index](../README.md) > Macro View Rotation\n"} {"id": "freecad-docs:wiki/Manipulator_workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Manipulator_workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Manipulator_workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "646ab5cad3eb9eb661366630a63d3ad8878427c932e055135e65fc383c7e75d9", "bytes": 158, "tokens": 60, "text": "# Manipulator workbench\n1. REDIRECT [Manipulator Workbench](Manipulator_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > Manipulator workbench\n"} {"id": "freecad-docs:wiki/Manual_Introduction.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Manual_Introduction.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Manual_Introduction.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e713b06179de8065d67c874fd83bf74072229bc47888df8f94f4e886557ebf22", "bytes": 3330, "tokens": 766, "text": "# Manual:Introduction\n[FreeCAD](https://www.freecad.org) is an open-source, free parametric 3D computer-aided design (CAD) modelling tool used to create objects ranging from simple designs to complex projects consisting of extensive assemblies of numerous parts. Due to its open-source nature, FreeCAD can be freely downloaded, distributed, modified, and used for both personal and commercial purposes. The source code is openly published under the [LGPL](https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License) license. This makes FreeCAD an appealing option not only for relatively inexperienced users, such as hobbyists in the 3D printing world, but also for experienced users looking to experiment with a different parametric tool.\n\nThe software was initially released in its infancy in 2002. Since then, thanks to the continuous contributions from a devoted community of developers and users, FreeCAD has grown slowly but steadily. The passionate efforts of numerous contributors have not only improved FreeCAD\\'s capabilities as a CAD tool but have also led to the development of additional functionalities in separate domains closely tied to the base FreeCAD suite. Some notable examples include the FEM workbench, which enables the execution of simple Finite Element Analysis, as well as the BIM workbench which offers Building Information Modeling (BIM) capabilities.\n\nThis user manual is being written and updated for version [1.0](Release_notes_1.0.md) of FreeCAD. Its purpose is to serve as a guide for individuals who wish to start using FreeCAD for their projects. No extensive prior knowledge of any CAD software is required, and the contents of this manual are organized in a straightforward and comprehensive manner, divided into various application areas. The guide includes instructions regarding the installation of FreeCAD, the use of its most prominent workbenches, and extends to more complex topics such as Python scripting. Efforts have been made to present the information in an organized, step-by-step fashion, complete with images. This structure ensures that both novice CAD users and more experienced individuals can benefit from studying this manual. The contents of this manual are published under the [Creative Commons 4.0](http://creativecommons.org/licenses/by/4.0/) license, and can be freely used, downloaded, copied, and modified. The FreeCAD Manual is continuously improved through user experiences and contributions. A [Python script](https://wiki.freecad.org/FreeCAD_manual_converter) is available to convert the latest version of this manual into PDF or EPUB formats for offline reading.\n\nAnother valuable resource is the [FreeCAD wiki](Main_Page.md), where numerous contributors have added useful information covering every aspect of the software. Due to the wealth of information available, navigating and using the wiki can be somewhat challenging and overwhelming, especially for new users. For this reason, it is advised to first study the user manual, which offers a more streamlined and smooth introduction, before delving into the more extensive details available in the wiki. Finally, the [FreeCAD Forums](https://forum.freecad.org/) are also very helpful and provide additional support and insights.\n\n\n---\n⏵ [documentation index](../README.md) > Manual:Introduction\n"} {"id": "freecad-docs:wiki/Mesh.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "264de9735e468866ad55d454ef9d9c8571852c4c5a2171b92d68ebbab7f8e580", "bytes": 3252, "tokens": 1013, "text": "# Mesh\n## Introduction\n\nIn FreeCAD the word \\\"[Mesh](Mesh.md)\\\" is normally used to refer to a [Mesh MeshObject](Mesh_MeshObject.md) (`Mesh::MeshObject` class), a type of object that defines 3D data but is not a solid \\\"[Shape](Shape.md)\\\".\n\nMeshes are very simple objects, containing only vertices (points), edges and triangular faces. In general, they are easy to create, modify, subdivide, and stretch, and can be passed from one application to another without any loss of detail. In addition, since meshes contain very simple data, 3D applications like animation software and video games can manage very large quantities of them (millions of triangles) without using a lot of computing resources.\n\nHowever, in the field of engineering meshes present one big limitation: they are only made of surfaces, and have no \\\"mass\\\" information, so they don\\'t behave like \\\"solids\\\". This means that solid-based operations, like [boolean addition or subtraction](Part_Boolean.md), are difficult to perform on meshes. Also, since they are defined by individual points, they are hard to describe in a parametric fashion.\n\nSee [Mesh MeshObject](Mesh_MeshObject.md) for more information about this type of object, and see [Polygon mesh](https://en.wikipedia.org/wiki/Polygon_mesh) for generic information in computer systems.\n\n![](images/Shape_and_mesh.svg )\n\n\n*Left: parametric [shape](Shape.md) defined by properties. Right: [mesh](Mesh.md), defined by vertices and triangular surfaces.*\n\n## Usage\n\nMeshes are normally created by internal functions of the [Mesh Workbench](Mesh_Workbench.md), or by importing mesh format files, like STL and OBJ.\n\nEssentially, every object derived from a [Mesh Feature](Mesh_Feature.md) (`Mesh::Feature` class) is expected to hold and manipulate a Mesh.\n\nSince FreeCAD is primarily designed to be a solid modeller, it is better suited to deal with solid [Shapes](Shape.md). It can import and display Meshes in the [3D view](3D_view.md), and the [Mesh Workbench](Mesh_Workbench.md) offers some commands to directly manipulate them. But in many cases the Mesh first needs to be converted to a [Shape](Shape.md) (see [Part ShapeFromMesh](Part_ShapeFromMesh.md)), or the geometry needs to be recreated using solid modelling techniques from the [Part Workbench](Part_Workbench.md) or the [PartDesign Workbench](PartDesign_Workbench.md).\n\n## Finite element meshes \n\nIn FreeCAD the word \\\"[Mesh](Mesh.md)\\\" may also refer to a specific object that will be used in finite element analysis (FEA).\n\nWhen an object with a solid [Shape](Shape.md) is used in the [FEM Workbench](FEM_Workbench.md) it will be discretized into a triangular mesh. In this case, the resulting object is a [FEM FemMeshObject](FEM_Mesh.md) (`Fem::FemMeshObject` class), and is not derived from a [Mesh Feature](Mesh_Feature.md) (`Mesh::Feature` class).\n\nFor more information see [FEM Workbench](FEM_Workbench.md) and [FEM Mesh](FEM_Mesh.md).\n\n## More information \n\n- [Polygonal (mesh) geometry](https://forum.freecadweb.org/viewtopic.php?f=8&t=47493)\n\n {{Mesh Tools navi}} {{FEM Tools navi}} {{Document objects navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Glossary](Category_Glossary.md) > [Mesh](Category_Mesh.md) > [FEM](Category_FEM.md) > Mesh\n"} {"id": "freecad-docs:wiki/Mesh_AddTriangle.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Mesh_AddTriangle.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Mesh_AddTriangle.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0c1616dced2ff4e770223387deb9f35938a5b9ed3dc987fa16ffb16d9e5a1789", "bytes": 160, "tokens": 75, "text": "# Mesh AddTriangle\n1. REDIRECT [Mesh_AddFacet](Mesh_AddFacet.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Mesh](Mesh_Workbench.md) > Mesh AddTriangle\n"} {"id": "freecad-docs:wiki/Migrating_to_FreeCAD_from_Revit.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Migrating_to_FreeCAD_from_Revit.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Migrating_to_FreeCAD_from_Revit.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ad63c309a848d77ca8618db27001a43aefd8bdf1f6a79d07c9f039840579da73", "bytes": 4474, "tokens": 1221, "text": "# Migrating to FreeCAD from Revit\nThis page is intended to give you a quick start with FreeCAD if you are coming from Autodesk Revit.\n\n### Setting things up \n\nFreeCAD is a multi-purpose 3D modeling application. Although it is not solely a BIM application, it features a dedicated [BIM Workbench](BIM_Workbench.md), which is bundled with every FreeCAD installation, and contains a set of BIM tools.\n\n### Key concepts \n\nAlthough you will be able to perform the same tasks and obtain a similar result to what you are used to in Revit, both software are different and you should learn the differences.\n\n- The Revit file format (.RVT) is proprietary, non-documented, and is not supported by FreeCAD (supporting it would be a gigantic task which would swallow all of FreeCAD resources for a very incomplete result). Instead, you should rely on open formats such as [IFC](Arch_IFC.md), which is rather well supported by both applications. Families can also be exported to ACIS/SAT which is supported by the InventorLoader addon, installable via the [Addons manager](Std_AddonMgr.md).\n\n- BIM assets such as windows, equipment or furniture are usually easy to find on popular websites such as [bimobject.com](https://bimobject.com) in IFC format. But the format does not always guarantee the quality of the geometry. The [grabcad library](https://grabcad.com/library?softwares=step-slash-iges) has a good selection of downloadable assets in STEP format with good geometry quality.\n\n- There is no concept of family in FreeCAD. But there are many ways to obtain the same result, that is, several objects that share the same properties and are linked together (if you modify one, you modify them all). The most straightforward is [cloning](Draft_Clone.md). A clone is like a copy of an object, but if you modify the original object, its clones will get updated too. But there are other, more subtle ways to make objects share properties. For example, you can draw a 2D profile and build several objects from the same 2D profile.\n\n- Although they can be convenient, you don\\'t need to use the BIM tools to produce BIM objects. Any FreeCAD object, or even objects made with another software, can become BIM objects. You only need to select one and use the [Component](Arch_Component.md) tool. This also allows you to use other tools, for example from the [PartDesign Workbench](PartDesign_Workbench.md), to create complex objects that are usually hard to achieve with standard BIM tools.\n\n- Objects created with one BIM tool can have all supported BIM types. You only need to change their **IFC Type** property. So, for example, you can create a beam using the wall tool, just by changing its IFC type to \\\"Beam\\\" afterwards.\n\n- BIM tools follow the [Draft Workbench](Draft_Workbench.md) philosophy: They can be created anywhere and anyhow in the 3D space. You just need to set your [working plane](Draft_Snap_WorkingPlane.md) correctly, then next BIM objects will be created on that plane.\n\n- There is no mandatory building structure (floors in Revit) in FreeCAD. You can group your objects using [groups](Std_Group.md), or [Building parts](Arch_BuildingPart.md) (which are commonly used to make levels, but can actually be used for any kind of grouping) to work the same way as in Revit, but you are the one who chooses the most appropriate way for your project.\n\n### Suggested adoption workflow \n\n- Don\\'t try to migrate at once. Learning a new software is a complex task. FreeCAD is free, start with installing and exploring it, then when you can, use it to model a small part of a project, then as you gain knowledge and mastery, do more and more in FreeCAD and less in Revit.\n\n- Make sure you can always fall back to Revit if things go wrong: Export to IFC early and often, open the file in Revit, make sure everything is there.\n\n- Creating views and sheets works like in Revit, if you are using [Draft](Draft_Workbench.md) views (the recommended way). Create [shape views](Draft_Shape2DView.md) of your objects or levels, move them out of your model, annotate them, place everything in a group or [Building part](Arch_BuildingPart.md), then create [TechDraw](TechDraw_Workbench.md) pages and add your Draft views to it.\n\n### Further reading \n\n- the [BIM Workbench](BIM_Workbench.md)\n- [FreeCAD BIM migration guide](https://yorik.uncreated.net/blog/2020-010-freecad-bim-guide)\n\n\n---\n⏵ [documentation index](../README.md) > Migrating to FreeCAD from Revit\n"} {"id": "freecad-docs:wiki/NativeIFC.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/NativeIFC.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/NativeIFC.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6167a9a414db05895eb0b84cec1dd0865cb1249349533d1476d74259838fab63", "bytes": 16674, "tokens": 4301, "text": "# NativeIFC\n**Warning**: The NativeIFC functionality is still a work-in-progress and is not finished. Please bear that in mind when using and not rely on it until you are confident it can do what you intend. See the [development roadmap](https://github.com/yorikvanhavre/FreeCAD-NativeIFC/blob/main/doc/roadmap2024.md) to read more about the development, what\\'s working and what\\'s planned.\n\n## Introduction\n\nStarting from version 1.0, FreeCAD uses the [Native IFC concept](https://github.com/brunopostle/ifcmerge/blob/main/docs/whitepaper.rst). It allows FreeCAD users to open, manipulate and create IFC files natively in FreeCAD.\n\nAlthough FreeCAD already supported opening and saving IFC files through the Arch workbench for a long time, it did so, like most other BIM applications, by translating back and forth between the IFC file format and FreeCAD\\'s internal data model. This means two translations, one when opening and another one when saving, which cause data loss, and a complete rewrite of the file each time. This turns it unsuitable for [version control systems](https://en.wikipedia.org/wiki/Version_control) like [Git](https://en.wikipedia.org/wiki/Git), and very hard to locate changes.\n\nNative IFC means that the IFC file is itself the data structure in FreeCAD. When opening an IFC file in FreeCAD, what you see on the screen is a direct rendering of the contents of the IFC file. Anything you modify will directly modify the IFC file. If you open a file, modify one element and save the file, the only thing that will have changed in the file is the line concerning that element. The rest of the file will be 100% identical to how it was before you saved. No data loss, and very identifiable changes.\n\nThe Native IFC idea itself comes from [this paper by Bruno Postle](https://github.com/brunopostle/ifcmerge/blob/main/docs/whitepaper.rst). It is heavily inspired by [BlenderBIM](https://blenderbim.org/) and tries as much as possible to use the same concepts and reuse the code. The final goal is to offer in FreeCAD the same level of functionality and performance found in BlenderBIM, and to upstream as much as possible to [IfcOpenShell](https://ifcopenshell.org/), the common IFC engine used by both applications. It started as a [separate project by Yorik](https://github.com/yorikvanhavre/FreeCAD-NativeIFC)\n\nWorking with native IFC files in FreeCAD is simple: Open an existing IFC file or create a new project using the [Project tool](BIM_Project.md) from the [BIM Workbench](BIM_Workbench.md). Create new objects with any of the FreeCAD workbenches or tools. Add these objects to your IFC project by dragging them into the project structure. Save the file, and you are done.\n\nRead below for more details.\n\n## Locked and unlocked modes \n\nThe [BIM Workbench](BIM_Workbench.md) offers two modes to work with IFC files. Switching between the two modes is done by clicking the **lock button** on the FreeCAD status bar:\n\n![](images/BIM-statusbar-lock.jpg )\n\n- **Unlocked mode** (default): You can have both Native IFC projects and non-IFC elements in a same FreeCAD document. You can also work on BIM models without creating any Native IFC project, and still export your model as IFC.\n- **Locked mode**: Your FreeCAD document is an IFC file. Anything you do will cause changes in the IFC file. Any new object you add is instantly converted to IFC.\n\nIn locked mode, all the objects you create are immediately converted to IFC, and might therefore loose some of their original properties and some of their parametric behavior when these are not supported by the IFC format. This mode is more restrictive, which is a disadvantage at some points in project development, but becomes an advantage when data integrity and reliability become essential.\n\nIt is also possible to create native IFC projects inside an unlocked document. In that case, strict IFC elements coexist with non-IFC elements in your FreeCAD document. Objects within an IFC project are linked to its attached IFC file. Working with IFC projects is often not needed at early stages of a project, but if you work with others and use IFC files as your main communication medium, using native IFC projects can become an advantage, as the changes in each version of the file are much smaller.\n\nYou can always export your model to IFC whenever needed, using IFC projects or not. The difference is that when you are using an IFC project, very minimal changes are written to the IFC file. When not, the whole file is rewritten at each export. This might or might not be an issue for you\n\nThe general idea is to work in unlocked mode when working on your own projects, so you can have both IFC and non-IFC elements in your documents, and use the locked mode when working on other people\\'s IFC files, so you can keep strict control over what you are changing in those files.\n\n## File concepts \n\nWhen working with native IFC files in FreeCAD, an IFC project (being locked or unlocked) always has an IFC file attached to it. That IFC file contains all the data of your IFC project inside FreeCAD and is also responsible for providing the geometry of its objects to FreeCAD.\n\nWhen creating a new IFC project, there is no IFC file yet, the first time you save the file FreeCAD will ask you where to save the IFC file.\n\nIn locked mode, you work directly in an IFC file. There is no more FreeCAD file.\n\nIn unlocked mode, you have IFC project objects attached to IFC files, and the FreeCAD document is dependent on these IFC files. If you wish to transmit your FreeCAD file to someone else, you need to given them the IFC files too. Alternatively, you can also set the Shape mode of all the objects to \\\"Shape\\\" (see below). This will make the FreeCAD file retain the shape of all the IFC objects, and render them correctly even without the attached IFC file. However, the IFC objects inside will no longer be editable.\n\n## IFC objects vs BIM objects \n\nWhen a BIM object or any other FreeCAD object is bound to a Native IFC [project](BIM_Project.md), it becomes an IFC object. Binding an object to a Native IFC project is done simply by dragging, in the tree view, the object onto the project or onto any object that is already part of that project, for example a building or a storey.\n\nOnce an object has become an IFC object, it is entirely controlled by the IFC data. It looses its former FreeCAD parametric object, and might loose any parametric properties and features that are not supported by the IFC format. The aim here is in the future to render all this seamless and keep the same editing possibilities for both IFC and non-IFC objects.\n\n## Opening and importing IFC files \n\nYou have two options: open or import.\n\n- If you open, a new document will be created and you will automatically be in **locked mode**\n- If you import, a native IFC [project](BIM_Project.md) object will be added to the current document, but you can still create non-IFC objects outside that project. You will still be in **unlocked mode**\n\nTo open an IFC file, use menu File -\\> Open and select an IFC file. To import an IFC file, use menu File -\\> Import and select an IFC file.\n\nTo maximize initial import speed, opening or importing IFC files will by default render only the top-level object (usually a Site) in FreeCAD. To expand the contents of this object, you need to double-click it in the tree view (see below).\n\nImporting or opening an IFC file does not require the setting of any option. However, some defaults can be tweaked under menu Edit -\\> Preferences -\\> BIM -\\> NativeIFC.\n\n## Creating a new IFC document \n\nYou can choose to work in locked or unlocked mode, depending mostly if you need to have non-IFC objects in your FreeCAD document (unlocked) or wish that everything you do in the document happens in the IFC file (locked).\n\nWhen creating a new IFC project, there is no attached IFC file yet. On first save, FreeCAD will ask you for a location to save an IFC file.\n\n**In locked mode:**\n\n1. Create a new FreeCAD document with menu File -\\> New\n2. Press the \"\" [IFC Lock](BIM_ToggleNativeIFC.md) button on the status bar to lock the document\n\n**In unlocked mode:**\n\n1. Press the \"\" [Project](BIM_Project.md) button to create a native IFC project in the current FreeCAD document. You can have more than one in a same FreeCAD document\n\n## Saving and exporting IFC files \n\nYou can always export any FreeCAD model to IFC, even if it was not built with BIM tools or contains non-BIM elements. The non-BIM objects will simply be exported as generic IfcBuildingElementProxy entities, while BIM objects can have their class (IfcWall, IfcDoor,\\...) defined.\n\nNativeIFC projects, be it in locked or unlocked mode, always have an attached IFC file. There is no need to export anything anymore, you just need to save that IFC file. The way you save IFC contents differs depending on the mode:\n\n- When working in **locked mode**, all of what happens in your FreeCAD document is saved to the IFC file. There is no need to save the FreeCAD file anymore, and the menu entries *File -\\> Save* and *File -\\> Save As* are replaced with *File -\\> Save IFC* and *File -\\> Save IFC As*. Saving the IFC file is all that\\'s needed, there is no more .FCStd file.\n\n- When working in **unlocked mode**, each IFC [project](BIM_Project.md) object in your document will be attached to a separate IFC file. A project object keeps track of changes and its icon will show a red dot when it contains unsaved changes. Saving your FreeCAD document will also save all the IFC files attached to IFC projects found in the document.\n\nIn unlocked mode, you can also save attached files manually by right-clicking the project and choosing IFC -\\> Save\n\n## Expanding file contents \n\nWhen opening an IFC file, only the top-level objects (usually the Site and Building) are rendered in FreeCAD by default (this can be changed under menu Edit -\\> Preferences -\\> BIM -\\> NativeIFC), and additional data such as materials, geometric properties, shape, layers, and child objects are not rendered.\n\nTo load all the additional data and show the direct children of an object, double-click it in the tree view.\n\nYou can also collapse expanded objects by right-clicking them in the tree and selecting IFC -\\> collapse children.\n\n## Loading and unloading shapes \n\nBy default, to gain speed, IFC objects don\\'t load their full shape. Only a lightweight 3D representation is shown in the 3D view. This warrants fast import and expand operations. However complex geometric operations such as boolean operations or sections performed by [section planes](Arch_SectionPlane.md) require the full shape to be present. In these cases, you might need to load the shape of the objects you need to perform these operations on.\n\nTo load the shape of selected objects, simply set their **Shape Mode** property to **Shape**.\n\nTo unload the shape and revert to the lightweight 3D representation mode, set the **Shape Mode** property to **Coin**. (Coin is the name of the 3D rendering library used in FreeCAD).\n\nA third shape mode exists, **None**, that switch off completely the visual representation of the IFC objects. These are then solely controlled via the tree view.\n\n## Classes, attributes and properties \n\nAll IFC objects always have at least two properties: **Class** and **Step ID**. The class is the IFC class (IfcWall, IfcWindow, etc\\...) and the Step ID is the ID of the element in the IFC file. The Step ID is actually the sole data needed to locate the object in the IFC file. You can change the class of an object anytime, it won\\'t have any impact over the geometry or property sets but might change available attributes (see below). You can only change to a sibling class, a parent class or a descendant class. If you want to change to a class that is very distant from the current class, you will need to know the IFC class structure and repeat the operation several times.\n\n**Attributes** are additional hard-coded properties of IFC objects, such as Name, Description or ID. Attributes depend on the class. For example, IfcWindows also have Length and Width, IfcSites have Longitude and Latitude, etc. Attributes are always grouped under the **IFC** group and are always loaded together with an object.\n\nWhen changing the class of an object, the attributes might change. You can edit the value of attributes, but you cannot add or remove attributes, as those are mandatory and defined by the IFC standard.\n\nIFC **properties**, which are grouped under property sets, are custom properties that can be attributed to any IFC object. They are not loaded by default, but get loaded when you double-click an object. The property sets, which are property packs that get attached to objects, get rendered as property groups inside the FreeCAD properties tree.\n\n## Layers and Materials \n\n**Layers** get loaded when double-clicking an object. Layers get represented as [normal FreeCAD layers](Draft_Layer.md), but they are hosted inside the IFC project. When using the [BIM Layers](BIM_Layers.md) tool, an additional icon indicates if the layer is part of an IFC project or not.\n\n**Materials** follow the same logic. They are only loaded when double-clicking the object, they are represented as normal [materials](Arch_Material.md), but get hosted inside the IFC project.\n\n## Building structure \n\nBy the IFC standards, all IFC files must contain one and only one IfcProject (or IfcProjectLibrary) object, which constitutes the root of your IFC model. All other IFC objects can be freely aggregated under this root object (an idea we call a \\\"flat file\\\"), but the IFC standards require to have at least one building container object (IfcSite, IfcBuilding or IfcBuildingStorey) under the root IfcProject. In FreeCAD, with the default options set, exported IFC files will always contain the IfcProject and at least one building container (default ones will be created if you don\\'t have one).\n\nAlthough it is not mandatory, it is common practice in IFC files to always have a same basic structure:\n\nIfcProject\n\n  -> IfcSite\n     -> IfcBuilding\n        -> IfcBuildingStorey\n\nYou can also use [groups](Std_Group.md) inside your IFC projects. However, the IFC standard does not allow to nest groups inside a building structure. So these groups will be converted to IfcAssemblies. However, since most BIM applications will happily work with nested groups, you can turn off this conversion in IFC export preferences.\n\n## Check for changes in an IFC project \n\nOne of the main advantages of the native IFC system, is that only the things you change in FreeCAD get reflected in the IFC file attached to a project. As a result, that IFC file contains only very few changes, as opposed to traditional BIM applications where the IFC file is completely rewritten at each export.\n\nThis allows to precisely locate the changes inside the file. Moving a wall, for example, changes only one line: The placement of that wall. This in turn allows version control systems like Git to precisely identify those changes, and only save the increments of each new version.\n\nYou can get a visual representation (diff) of the changes in a selected IFC project by using menu Utils -\\> IFC Diff or, in unlocked mode, right-clicking an IFC project and selecting IFC -\\> Diff.\n\n## Adding, deleting and modifying objects \n\nIn locked mode, any new object added (BIM or not) gets immediately converted to IFC. There is nothing more to do.\n\nIn unlocked mode, any new object (BIM or not) added to the document needs to added to an IFC project. This is done by dragging the object in the tree view and dropping anywhere inside the structure of an IFC project.\n\nDeleting objects that are inside an IFC project will delete them from the IFC file as well.\n\nOnce an object becomes an IFC object, it looses its former FreeCAD parametric abilities and inherits all its behaviour from the IFC file. As of FreeCAD 1.0, the editing possibilities of IFC objects are still limited, and are done entirely via properties (no graphical edit available yet). To edit an object, you must have loaded its geometry properties. This is done either by double-clicking it or right-clicking and choosing *IFC -\\> add geometric properties* in the tree view.\n\nEditable geometric properties such as \\\"Height\\\" or \\\"Width\\\" are then added to the object. This is a work in progress, not all properties are supported yet. Changing the value of these properties will change the shape of the object.\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > NativeIFC\n"} {"id": "freecad-docs:wiki/O-X-Y_type_attachment_modes.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/O-X-Y_type_attachment_modes.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/O-X-Y_type_attachment_modes.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "874d763148ad88890f9035744673acce8b54621c306d2244d596bae0e2b5975e", "bytes": 182, "tokens": 76, "text": "# O-X-Y type attachment modes\n1. REDIRECT [O-X-Y Type Attachment Modes](O-X-Y_Type_Attachment_Modes.md)\n\n\n---\n⏵ [documentation index](../README.md) > O-X-Y type attachment modes\n"} {"id": "freecad-docs:wiki/ODA.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/ODA.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/ODA.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "324080455ba3e5fc1df048e12ac26eb904c935795f6e17d7746a136de1bcf684", "bytes": 124, "tokens": 63, "text": "# ODA\n1. REDIRECT [FreeCAD_and_DWG_Import](FreeCAD_and_DWG_Import.md)\n\n\n---\n⏵ [documentation index](../README.md) > ODA\n"} {"id": "freecad-docs:wiki/Package_Metadata.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Package_Metadata.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Package_Metadata.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d2289992482d429f01acef4a9780644af25150dd7dd437d5f683787fc5d2c563", "bytes": 21304, "tokens": 6217, "text": "# Package Metadata\n## Introduction\n\nBeginning in FreeCAD version 0.20, external addons (workbenches, macros, and preference packs) may be distributed with a metadata file describing the contents of the package. If the file \\\"package.xml\\\" is present it is read by FreeCAD and its contents used in various parts of the user interface. It is currently optional for workbenches and macros, and required for preference packs. This page documents the format of that metadata file. The format (and the contents of this Wiki page) are based on [REP 149](https://ros.org/reps/rep-0149.html).\n\n## Overall file format \n\nThis document currently describes file format version 1.\n\nThe metadata file must be a valid, well-formed XML 1.0 document. It must be called \\\"package.xml\\\", and must exist in the base directory of the software package\\'s primary branch (as specified by the [FreeCAD-addons .gitmodules file](https://github.com/FreeCAD/FreeCAD-addons/blob/master/.gitmodules)) in its git repository. Only the package.xml file from the primary branch is considered by the Addon Manager. All understood XML tags are in lowercase, but unrecognized tags are **not** an error. Most tags are optional, and some only apply to certain types of package contents (for example, only Workbenches currently provide a \\\"classname\\\" element). Unneeded or unrecognized elements are ignored.\n\nAny file path specified in package.xml must use the slash (\\\"/\\\") as the directory separator: on systems that expect a different separator during execution (e.g. Windows) FreeCAD will automatically convert to the correct separator.\n\n## Content elements \n\n### \n\nThe only top-level element allowed is , and the file may only contain one element. Immediately subordinate to that are several required or optional elements, defined here. No other tags are permitted directly under the element.\n\n\n \n\n\nThe tag is the unique top-level tag in a package.xml file. All other tags are nested under it.\n\n#### Attributes\n\n- format=\\\"NUMBER\\\": Specifying the package.xml format being used. For this interface, you must specify format=\\\"1\\\".\n- xmlns=\\\"NAMESPACE\\\": Specifies the XML namespace for this package, and must be included exactly as shown above, as a link to .\n\n#### Required child tags \n\nThe top-level element must contain at least the following tags:\n\n- [](#.3Cname.3E.md)\n- [](#.3Cversion.3E.md)\n- [](#.3Cdate.3E.md)\n- [](#.3Cdescription.3E.md)\n- [](#.3Cmaintainer.3E.md) (multiple, but at least one)\n- [](#.3Clicense.3E.md) (multiple, but at least one)\n- [](#.3Cicon.3E.md)\n- [](#.3Ccontent.3E.md) (container element for package content items)\n\n#### Optional child tags \n\n- [](#.3Curl.3E.md) (multiple)\n- [](#.3Cauthor.3E.md) (multiple)\n- [](#.3Cdepend.3E.md) (multiple)\n- [](#.3Cconflict.3E.md) (multiple)\n- [](#.3Creplace.3E.md) (multiple)\n- [](#.3Ctag.3E.md) (multiple)\n- [](#.3Cfreecadmin.3E.md)\n- [](#.3Cfreecadmax.3E.md)\n- [](#.3Cpythonmin.3E.md)\n\n### \n\nREQUIRED\n\nThe name of this package. Must only contain characters that are valid for filenames (disallowed characters are /\\\\?%\\*:\\|\\\"\\<\\> ).\n\n### \n\nREQUIRED\n\nA version number that follows either the [semantic versioning 2.0 standard](https://semver.org) (e.g. 1.0.2-beta) or the [CalVer style](https://calver.org/) (e.g. 2021.12.08). Note that you cannot include both types, and switching between types is not supported. Internally the code has no concept of which type is chosen, when comparing versions it performs a simple numerical comparison between each successive numeric component regardless of type. Note that this cannot be left blank, some kind of version number must be assigned. When the Addon Manager detects an increase in version number it will display the \\\"update available\\\" information to users.\n\n### \n\nREQUIRED\n\nThe date of the current version, in the format YYYY-MM-DD or YYYY.MM.DD.\n\n### \n\nREQUIRED\n\nA concise (up to several sentences) text-only description of this package. No markup is supported.\n\n### \n\nAT LEAST ONE REQUIRED (multiple allowed)\n\nThe name of the person maintaining the package. All packages require a maintainer. For orphaned packages see below.\n\n#### Attributes \n\n- email=\\\"name@domain.tld\\\" (required): Email address of the maintainer.\n\nAn orphaned package is one with no current maintainer. Orphaned packages should use the following maintainer information:\n\n\n No current maintainer\n\n\n### \n\nAT LEAST ONE REQUIRED (multiple allowed)\n\nSPDX short identifier of the license(s) for this package, e.g. BSD-2-Clause, GPL-3.0-or-later, LGPL-2.1-or-later. In order to assist machine readability, only include the license\\'s SPDX short identifier (see [the SPDX site](https://spdx.org/licenses/)). For multiple licenses multiple separate tags must be used. A package will have multiple licenses if different source files have different licenses. Every license occurring in the source files should have a corresponding tag. For any explanatory text about licensing caveats, please use the tag. To specify that no license applies (e.g. \\\"All rights reserved.\\\") set this value to \\\"UNLICENSED\\\". To specify a custom license without an SPDX identifier set this value to \\\"SEE LICENSE IN \\\".\n\nCommonly-used license strings:\n\n- `\"Apache-2.0\"`\n \n\n- `\"BSD-2-Clause\"`\n \n\n- `\"BSD-3-Clause\"`\n \n\n- `\"BSL-1.0\"`\n \n\n- `\"GPL-2.0-or-later\"`\n \n\n- `\"GPL-3.0-or-later\"`\n \n\n- `\"LGPL-2.1-or-later\"`\n \n\n- `\"LGPL-3.0-or-later\"`\n \n\n- `\"MIT\"`\n \n\n- `\"MPL-1.1\"`\n \n\n- `\"CC0-1.0\"`(Public Domain dedication)\n\n**Backwards-compatibility note**: The Addon Manager will attempt to normalize license identifiers that do not exactly match an SPDX license string. This will sometimes result in a license ID that yields a non-FSF-Libre or non-OSI-approved license: for example \\\"LGPL2\\\" will be normalized to \\\"LGPL-2.0\\\", which is a non-FSF-Libre license: what was probably intended was \\\"LGPL-2.1-or-later\\\".\n\n#### Attributes \n\n- `file=\"FILE\"`(optional): A path relative to the `package.xml` file containing the full license text. Many licenses require including the license text when redistributing the software. E.g. the Apache License, Version 2.0 states in paragraph 4.1: \\\"You must give any other recipients of the Work or Derivative Works a copy of this License\\\"\n\n### \n\nREQUIRED\n\nThe tag describes the actual contents of the package. It has no attributes, and contains any number of children. Those children can have arbitrary tag names, only some of which may be recognized by FreeCAD. FreeCAD currently supports \\\"workbench\\\", \\\"macro\\\", and \\\"preferencepack\\\" elements. Each child is then defined recursively by this standard, containing any or all of the elements allowed for the root node. For example:\n\n\n \n \n Unicorn Sparkles Theme\n 1.0.0\n https://github.com/chennes/FreeCAD-themes/blob/main/Unicorn%20Sparkles%20Theme/Readme.md\n sparkles.svg\n \n \n\n\nThe existence of items implies a set of subfolders, one for each content item, named exactly as the given name of the item. So for the example above, the package\\'s folder structure is:\n\n\n Package Directory/\n package.xml\n Unicorn Sparkles Theme/\n Unicorn Sparkles Theme.cfg\n sparkles.svg\n (the theme's other files)\n\n\nIn addition to the other elements of , content items can optionally provide information in , , and tags (technically these can be provided to the root tag as well, but they are generally unused there).\n\n**Backwards-compatibility note**: to avoid having to restructure packages that pre-date this metadata standard, the optional [](#.3Csubdirectory.3E.md) tag is allowed to specify \\\"./\\\" as the subdirectory for a content item, in which case no subdirectory is required. This matches the pre-standard system where a single workbench was located at the top of the directory structure.\n\n#### \n\nREQUIRED for Workbenches\n\nThe path to an icon file. If it is an icon for the top-level package this path is relative to the package.xml file itself. If the icon is an element of a item, then the path is relative to the content\\'s folder. The Addon Manager will display the top-level icon as the icon for the overall package. If no top-level icon is present, the first specified workbench icon will be used as the package icon.\n\n#### \n\nOptional.\n\nNormally a content item is assumed to be located in a subdirectory with the same name as the item. In some cases, however, it is useful to explicitly specify the subdirectory. For example, many macros may be located within a single subdirectory, but each have their own entry in the package.xml file. It also provides backwards-compatibility support for packages that predate the package.xml file format specification, and do not follow the expected subdirectory structure. Often in these cases, a \\\"./\\\" is used to indicate that the item is not located in a subdirectory at all.\n\n#### \n\nREQUIRED for Workbenches\n\nFor workbenches, the name of the Python main entry class. This is the class that FreeCAD will try to load on startup to locate the workbench\\'s icon, which should be set as a member variable of the class. For example, if your workbench defines the following class (usually in InitGui.py):\n\n \n```python\nclass MyNewWB:\n Icon = \"resources/icon.svg\"\n```\n\nthen the package.xml file expects:\n\n\n MyNewWB\n\n\n#### \n\nOptional\n\nProvided for convenience to other tools, any number of other files may be listed here. Their use depends on the type of content. In a macro content item, each file entry is a single macro, and will be linked into the user\\'s Macros installation directory by the [Addon Manager](Std_AddonMgr.md).\n\n### \n\nMultiple allowed: \\\"repository\\\" is required, and \\\"readme\\\"-type is highly recommended.\n\nA Uniform Resource Locator for the package\\'s website, bug tracker, source repository, zip download link, readme file, or documentation (as specified by the \\\"type\\\" attribute, see below).\n\nWhen specifying the \\\"readme\\\" type, a direct link to a rendered version of the README should be provided. For example, on GitHub, this is a \\\"blob\\\"-type link such as \\\"\\\", or on a GitLab instance, \\\"\\\" (note the slightly different URL format between the two).\n\nIt is a good idea to include tags pointing users to your package\\'s online resources. The website is commonly a wiki page on wiki.freecad.org where users can find and update information about the package, for example. The Addon Manager lists these URLs and provides clickable links to them in the package description.\n\n#### Attributes \n\n- type=\\\"TYPE\\\" (required): The type should be one of the following identifiers: \\\"website\\\", \\\"bugtracker\\\", \\\"repository\\\", \\\"readme\\\", \\\"documentation\\\", or \\\"discussion\\\".\n- branch=\\\"BRANCH\\\" (required for type=\\\"repository\\\"): The name of the branch to check out to obtain this package. Typically the name of your main development branch. May also specify any other type of git reference, e.g. a tag or specific commit.\n\n### \n\nMultiple allowed\n\nThe name of a person who is an author of the package, as acknowledgement of their work and for questions.\n\n#### Attributes \n\n- email=\\\"name@domain.tld\\\" (optional): Email address of author.\n\n### \n\nMultiple allowed\n\nDeclares a dependency on another FreeCAD Addon or internal workbench, or Python package. The named dependency is first checked against the list of known Addons (e.g. those available either from the official FreeCAD Addons git repository, or those in a custom user-specified repository). The check is against the canonical name of the Addon. If a package.xml file is present for that Addon, the name is that package\\'s element. An exact match is required. If no match is found it is checked against the list of known internal workbenches (both installed and uninstalled). Finally, if the named dependency has not been located in the previous two steps it is assumed to be a Python package dependency. Note that not all dependency-related features are fully implemented yet.\n\n#### Attributes \n\nAll dependencies and relationships may restrict their applicability to particular versions. For each comparison operator an attribute can be used. Two of these attributes can be used together to describe a version range.\n\n- version_lt=\\\"VERSION\\\" (optional): The dependency to the package is restricted to versions less than the stated version number.\n- version_lte=\\\"VERSION\\\" (optional): The dependency to the package is restricted to versions less or equal than the stated version number.\n- version_eq=\\\"VERSION\\\" (optional): The dependency to the package is restricted to a version equal than the stated version number.\n- version_gte=\\\"VERSION\\\" (optional): The dependency to the package is restricted to versions greater or equal than the stated version number.\n- version_gt=\\\"VERSION\\\" (optional): The dependency to the package is restricted to versions greater than the stated version number.\n- condition=\\\"CONDITION_EXPRESSION\\\": Every dependency can be conditional on a condition expression. If the condition expression evaluates to \\\"true\\\" the dependency is used and considered as if it doesn\\'t have a condition attribute. If the condition expression evaluates to \\\"false\\\" the dependency is ignored and considered as if it doesn\\'t exist. The expression must be a valid FreeCAD Expression (i.e. Python syntax), and may refer to the variables \\\"\\$BuildVersionMajor\\\", \\\"\\$BuildVersionMinor\\\", and \\\"\\$BuildRevision\\\" representing the version of FreeCAD currently running.\n- optional=\\\"true\\|false\\\": If \\\"optional\\\" is \\\"true\\\", then the dependency is treated as optional when the Addon is installed using the Addon Manager. In general this means that a failure to install the dependency does not prevent the Addon from installing, and the user may be prompted about whether they want to install it. Versions of FreeCAD prior to 0.21 do not recognize this attribute and will ignore it.\n- type=\\\"automatic\\|addon\\|internal\\|python\\\": Optional, defaults to \\\"automatic\\\". Indicates what this dependency statement refers to. \\\"addon\\\" is for external addons, \\\"internal\\\" is for internal workbenches (e.g. \\\"arch\\\", \\\"sketcher\\\", etc.), and \\\"python\\\" indicates a Python package dependency. Versions of FreeCAD prior to 0.21 do not use this attribute, and \\\"automatic\\\" is always assumed.\n\n### \n\nMultiple allowed\n\nDeclares a package name with which this package conflicts. This package and the conflicting package should not be installed at the same time.\n\n#### Attributes \n\nSee .\n\n### \n\nMultiple allowed\n\nDeclares a package name that this package is intended to replace.\n\n#### Attributes \n\nSee .\n\n### \n\nA simple text tag used for categorization when using a package manager. Multiple elements may be specified.\n\n### \n\nThe minimum version of FreeCAD required to use this package/element, as a semantic version 2.0 string in the format MAJOR.MINOR.BUILD\n\n### \n\nThe maximum version of FreeCAD required to use package/element, as a semantic version 2.0 string in the format MAJOR.MINOR.BUILD\n\n### \n\n(New in FreeCAD 0.21, ignored by previous versions.) The minimum version of Python required to use package/element, as a semantic version 2.0 string in the format MAJOR.MINOR. The Addon Manager will not permit an Addon to be installed on a system running a version of Python before this one. Only Python 3.x versions are supported. Although you may specify a three-component version, only the minor number is considered during the compatibility check.\n\n## Validation\n\nTo validate your package.xml file you can enable \\\"developer mode\\\" in the Addon Manager: create a boolean variable called \\\"developerMode\\\" in the \\\"Addons\\\" parameter group and set it to True: **Tools → Edit parameters... → BaseApp → Preferences → Addons → developerMode**. When the Addon Manager has finished reading the Addons database it will examine all available package.xml files for errors.\n\n## Quick guide \n\nFor a quick guide on how to create a basic package.xml file and add a workbench to the [Addon Manager](Std_AddonMgr.md) see: [Add Workbench to Addon Manager](Add_Workbench_to_Addon_Manager.md).\n\n## Examples\n\nNote that comments (the text between `<!--` and `-->`) are ignored by the XML parser, and are not a required part of the file format. They are provided here for information purposes and may be omitted from the final package.xml if desired.\n\nA simple workbench-only package (for example, to add a metadata file to a package that predates this metadata format):\n\n\n \n \n Legacy Workbench \n Text that the Addon Manager shows for the Addon. Any length, but remember that Addon Manager's compact view only shows the first sentence or so.\n 1.0.1 \n 2022-01-07 \n Your Name\n LGPL-2.1-or-later \n https://github.com/chennes/FreeCAD-Package \n https://github.com/chennes/FreeCAD-Package/blob/main/README.md \n Resources/icons/PackageIcon.svg \n\n \n \n MyLegacyWorkbench \n ./\n \n \n\n \n\n\nA complex, multi-component package:\n\n\n \n \n Example Package Format\n An example of the package.xml file format\n 2022.01\n 2022-01-07\n No Maintainer\n GPL-3.0-or-later\n https://github.com/chennes/FreeCAD-Package\n PackageIcon.svg\n\n \n \n FreeCAD Classic Colors\n FreeCAD default colors for core app and included Mods.\n 1.0.0\n color\n stylesheet\n \n \n Metadata Creation Workbench\n A set of tools to assist in creation of package.xml metadata files\n MetadataCreationWorkbench\n MCW\n Resources/mcw.svg\n developers\n 0.9.0-alpha\n \n \n Problem Solver 9000\n Deletes all emails in your inbox\n ./\n PS9000.FCMacro\n \n \n\n \n\n\nA package with dependencies:\n\n\n \n \n Example with Dependencies\n An example of the package.xml file format\n 1.0.1-beta3\n 2022-01-07\n No Maintainer\n GPL-3.0-or-later\n https://github.com/chennes/FreeCAD-Package\n PackageIcon.svg\n\n \n \n Metadata Creation Workbench\n A set of tools to assist in creation of package.xml metadata files\n MetadataCreationWorkbench\n MCW\n Resources/mcw.svg\n developers\n\n FEM\n Curves workbench\n Steel column\n\n \n markdown\n TabBar\n\n \n Metadata Creation Workbench Beta\n\n \n Do not use with build 24267 \n\n \n matplotlib\n some_other_package \n \n \n\n \n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Package Metadata\n"} {"id": "freecad-docs:wiki/PartDesign_NewSketch.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_NewSketch.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_NewSketch.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3876ab51d4750f3af8cb5bd9dd66719e9c9831469d76737afd45377c7c964b45", "bytes": 3834, "tokens": 1122, "text": "---\n GuiCommand:\n Name: PartDesign NewSketch\n MenuLocation: Sketch , Create sketch\n Workbenches: PartDesign_Workbench\n Version: 0.17\n SeeAlso: Sketcher_NewSketch\n---\n\n# PartDesign NewSketch\n\n## Description\n\nThis tool creates a new sketch, creates a new [PartDesign Body](PartDesign_Body.md) to contain the sketch if one does not exist and automatically opens the [Sketcher workbench](Sketcher_Workbench.md) after creation.\n\nWhen creating models using the [PartDesign workbench](PartDesign_Workbench.md), this tool should be preferred to the **[ [Sketcher NewSketch](Sketcher_NewSketch.md)** tool found in the [Sketcher workbench](Sketcher_Workbench.md).\n\n## Usage\n\n1. Press the **[ [PartDesign NewSketch](PartDesign_NewSketch.md)** button from the PartDesign toolbar.\n2. In the Tasks panel, the **Select feature** dialog is brought up. Select one of the planes in the list or in the 3D view which can be reoriented for better visibility.\n3. Press **OK**.\n4. The interface automatically switches to the Sketcher workbench and the sketch can be edited. Once the sketch is exited, the interface is brought back to the PartDesign workbench and the 3D view is restored to the view orientation prior to creating the sketch.\n5. Alternatively, a plane or a face on the existing active body can be selected before creating the sketch, in which case the sketch is instantly created.\n\n## Options\n\n- To change the attachment of an existing sketch, change its **Map Mode** property (see [Properties](#Properties.md).)\n\n- The *Select feature* Dialog defines the features of the new sketch\n\n: \n\n : \"\"\n\n : *Select feature* dialog. These settings create a sketch on the XY plane and allow cross-references from other items of the same body\n\nDialog settings\n\n- Coordinate system box: defines the orientation of the sketch plane\n- Allow Used Features: *TBD*\n\n: Allow external features options\n\n- From other bodies of the same part: any elements used in the same body can be referenced\n- From different parts or free features: *TBD*\n- Make independent copy: all other elements will be separate copies, i.e. they will not change when the original changes.\n- Make dependent copy: the elements will be copies, but a dependency to the original elements is kept. This is basically using a [Shapebinder](PartDesign_ShapeBinder.md)\n- Create cross-reference: the linked elements will not be copies, but point to the original elements, e.g. a master sketch. Any changes are reflected to this sketch\n\nTo reference any items in the [Workbench Sketcher](Sketcher_Workbench.md) use the ** [External Geometry](Sketcher_External.md)** and **[ [CarbonCopy](Sketcher_CarbonCopy.md)** tools. Generally it is recommended to use other sketches as source for references rather than faces or edges, because they are less affected by the Topological Naming Issue.\n\n## Properties\n\n- **Map Mode**: mode of attachment of the sketch to another object, usually a plane or a face but can be other types of objects. Click once in the field to reveal a **...** button and press it to open the [Attachment](Part_EditAttachment.md) dialog. If set to Deactivated, the Placement property is enabled.\n\n- **Placement**: controls the orientation of the sketch in the 3D space; see [placement](Std_Placement.md). Disabled if the sketch is attached through the Map Mode property.\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign NewSketch\n"} {"id": "freecad-docs:wiki/PartDesign_SubtractiveBox.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_SubtractiveBox.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_SubtractiveBox.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4c061c2f3034f459246d34af6a7225a12602fdebf8991438c3fb9c50d0a7554f", "bytes": 1929, "tokens": 586, "text": "---\n GuiCommand:\n Name: PartDesign SubtractiveBox\n MenuLocation: Part Design , Create a subtractive primitive , Subtractive box\n Workbenches: PartDesign_Workbench\n Version: 0.17\n SeeAlso: PartDesign_CompPrimitiveSubtractive, PartDesign_AdditiveBox\n---\n\n# PartDesign SubtractiveBox\n\n## Description\n\nInserts a subtractive box in the active Body. Its shape is subtracted from the existing solid.\n\n ![](images/PartDesign_SubtractiveBox_example.png ) *On the left: active body (A) shown in grey and subtractive box (B) shown in transparent red; result on the right.*\n\n## Usage\n\n1. Press the ** '''Subtractive Box'''** button. **Note**: the Subtractive Box is part of an icon menu labelled *Create a subtractive primitive*. After launching FreeCAD, the Subtractive Box is the one displayed in the toolbar. If a different primitive is displayed, click on the down arrow besides the icon and select Subtractive Box in the menu.\n2. Set the Primitive parameters and [Attachment](Part_EditAttachment.md).\n3. Click **OK**.\n4. A Box feature appears under the active Body.\n\n## Options\n\nThe Box can be edited after its creation in two ways:\n\n- Double-clicking it in the Model tree, or by right-clicking and selecting **Edit primitive** in the contextual menu; this brings up the Primitive parameters.\n- Via the [Property editor](Property_editor.md).\n\n## Properties\n\n- **Attachment**: defines the attachment mode as well as the Attachment Offset. See [Part EditAttachment](Part_EditAttachment.md).\n\n- **Label**: Label given to the Box object. Change to suit your needs.\n\n- **Length**: the Box\\'s dimension in the X-direction.\n\n- **Width**: the Box\\'s dimension in the Y-direction.\n\n- **Height**: the Box\\'s dimension in the Z-direction.\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign SubtractiveBox\n"} {"id": "freecad-docs:wiki/PartDesign_SubtractivePrism.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_SubtractivePrism.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_SubtractivePrism.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "26c71a3ee24d554732e46f8ffd6fa36c518aaac3125c632ccd409ceaa68b3b6d", "bytes": 2250, "tokens": 685, "text": "---\n GuiCommand:\n Name: PartDesign SubtractivePrism\n MenuLocation: Part Design , Create a subtractive primitive , Subtractive Prism\n Workbenches: PartDesign_Workbench\n Version: 0.17\n SeeAlso: PartDesign_CompPrimitiveSubtractive, PartDesign_AdditivePrism\n---\n\n# PartDesign SubtractivePrism\n\n## Description\n\nInserts a subtractive prism in the active Body. Its shape is subtracted from the existing solid.\n\n ![](images/PartDesign_SubtractivePrism_example.svg ) \n\n*On the left: active body (A) shown in grey and subtractive prism (B) shown in transparent red; result on the right.*\n\n## Usage\n\n1. Press the ** '''Subtractive Prism'''** button. **Note**: the Subtractive Prism is part of an icon menu labelled *Create an subtractive primitive*. After launching FreeCAD, the Subtractive Box is the one displayed in the toolbar. To get the Prism, click on the down arrow besides the visible icon and select Subtractive Prism in the menu.\n2. Set the Primitive parameters and [Attachment](Part_EditAttachment.md).\n3. Click **OK**.\n4. A Prism feature appears under the active Body.\n\n## Options\n\nIt is possible to create skewed prisms by specifying angles in respect to the normal vector of the chosen attachment.\n\nThe Prism can be edited after its creation in two ways:\n\n- Double-clicking it in the Model tree, or by right-clicking and selecting **Edit primitive** in the contextual menu; this brings up the Primitive parameters.\n- Via the [Property editor](Property_editor.md).\n\n## Properties\n\n- **Attachment**: defines the attachment mode as well as the Attachment Offset. See [Part EditAttachment](Part_EditAttachment.md).\n\n- **Label**: label given to the Prism object. Change to suit your needs.\n\n- **Polygon**: number of sides in the polygon cross-section of the prism.\n\n- **Circumradius**: [circumscribed radius](https://en.wikipedia.org/wiki/Circumscribed_circle) of the polygon cross-section of the prism.\n\n- **Height**: height of the prism.\n\n- **First Angle**: angle in first direction.\n\n- **Second Angle**: angle in second direction.\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign SubtractivePrism\n"} {"id": "freecad-docs:wiki/PartDesign_WizardShaft.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/PartDesign_WizardShaft.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/PartDesign_WizardShaft.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3bd58492673f1ad1cde838db925cb4afeb0bee0b7f0d6399c9327f352765e6d6", "bytes": 3024, "tokens": 823, "text": "---\n GuiCommand:\n Name: PartDesign WizardShaft\n MenuLocation: Part Design , Shaft design wizard...\n Workbenches: PartDesign_Workbench\n---\n\n# PartDesign WizardShaft\n\n## Description\n\nThis tool allows you to create a shaft from a table of values, and to analyse forces and moments.\n\n## Usage\n\nYou can start the wizard from the Part Design menu **Part Design → [ Shaft design wizard...**.\n\nThe wizard will start and show a default table, the corresponding shaft part and force/moment graphs.\n\n\"\"\n\nThe top of the window is taken up by the table. It is organized into numbered columns which correspond to segments of the shaft. A shaft segment is characterized by having certain length and diameter. The main window shows two tabs. One is the shaft part itself (a revolution feature), shown in the image above. The second tab shows graphs of the shear forces and moments created by the loads defined in the table.\n\n\"\"\n\n## Prerequisites\n\nThe shaft design wizard depends on the [matplotlib](http://matplotlib.org/) library to create and display the graphs of shear force and bending moment. On Debian/Ubuntu-based systems, it is available through the python-matplotlib package.\n\n## Parameters\n\nFor each shaft segment, the following parameters can be defined\n\n- Length of the segment\n- Diameter of the segment\n- Load type. Note that you have to click on the desired entry in the menu after scrolling to it, otherwise it will not be selected!\n - None: No load\n - Fixed: The end of the shaft is fixed (e.g. welded to another part). This load type can only be defined for the first or last segment.\n - Static: There is a static load on this shaft segment\n- Load on the shaft segment\n- Location where the load is applied to the segment. The location is counted from the left-hand edge of the segment\n\n(Other rows and load types exist but no functionality has been implemented yet)\n\n## Menus\n\nTo add a new shaft segment, right-click into the empty space to the right of the table, and choose \\\"Add column\\\".\n\n## Limitations\n\n- It is not possible to have adjacent shaft segments with the same diameter.\n\n## Planned functionality \n\n- Table-driven chamfers and rounds on the shaft edges\n- Recognize a previously created shaft wizard part and initialize the table values from it\n- Shaft stress calculation\n- Visualization of loads on the shaft (can use the same functionality as for FEM module)\n- Definition of loads as a Document Object (can use the same functionality as for FEM module)\n- Material database\n- Allow loads in the Z-direction as well as in Y-direction (requires definition of loads as a Document Object, otherwise the table will become very long)\n\n\n {{PartDesign Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [PartDesign](PartDesign_Workbench.md) > PartDesign WizardShaft\n"} {"id": "freecad-docs:wiki/Part_SliceApart.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Part_SliceApart.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Part_SliceApart.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "45d634e5726b5b8b14a57092b612a1ca49c676f13b8ca521246e1f96ed5aa5c4", "bytes": 3307, "tokens": 1081, "text": "---\n GuiCommand:\n Name: Part SliceApart\n MenuLocation: Part , Split , Slice apart\n Workbenches: Part_Workbench\n Version: 0.18\n SeeAlso: Part_Slice, Part_ExplodeCompound\n---\n\n# Part SliceApart\n\n## Description\n\nTool to split shapes by intersection with other shapes. For example, for a box and a plane, two solids are created. ![600px](images/Part_Slice_Demo.png) \n\n\n* Above: the pieces were moved apart manually afterwards, to reveal the slicing.*\n\n[Slice apart](Part_SliceApart.md) is the same as \"\" [Part Slice](Part_Slice.md) followed by \"\" [Part Explode Compound](Part_ExplodeCompound.md). While \\\"Slice to compound\\\" is fully-parametric, and causes no trouble as the number of pieces changes, \\\"Slice apart\\\" will not update the number of objects as the number of pieces changes. They both create Slice parametric feature, that puts the sliced pieces into a compound, but \\\"Slice apart\\\" explodes the resulting compound into separate objects.\n\nThe output shape occupies the same space as the original. But it is split where it intersects with other shapes. The split pieces are individual pieces.\n\nPlease visit [Part Slice](Part_Slice.md) page for more info.\n\n### Tree structure of Slice Apart \n\nThe Slice Apart command creates more than only the sliced object. In the following example a cube is sliced by a face.\n\nThe slice is created and for each piece of it there is a [Part CompoundFilter](Part_CompoundFilter.md) created, thus the same slice occurs multiple times below each CompoundFilter. All these CompoundFilters are united in a Compound.\n\n![](images/Part_SliceApartTree.png )\n\n## Example\n\n- Making a puzzle: see [Part Slice](Part_Slice.md) example Steps 1 to 6\n\n## Scripting\n\nThe tool can by used in [macros](macros.md) and from the python console by using the following function: \n\n`BOPTools.SplitFeatures.makeSlice(name)`\n\n\nSet mode to **split** for slice apart\n\n- Creates an empty Slice feature. The \\'Base\\' and \\'Tools\\' properties must be assigned explicitly, afterwards.\n- Returns the newly created object.\n\nSlice can also be applied to plain shapes, without the need to have a document object, via: This can be useful for making custom Python scripted features.\n\nExample: {{code|code=\nimport BOPTools.SplitFeatures\nj = BOPTools.SplitFeatures.makeSlice(name= 'Slice')\nj.Base = FreeCADGui.Selection.getSelection()[0]\nj.Tools = FreeCADGui.Selection.getSelection()[1:]\n}}\n\nThe tool itself is implemented in Python, see **/Mod/Part/BOPTools/SplitFeatures.py** ([GitHub link](https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Part/BOPTools/SplitFeatures.py)) within the FreeCAD installation directory.\n\n## Notes\n\nSlice Apart was introduced in FreeCAD v0.18.15506. FreeCAD needs to be compiled with OCC 6.9.0 or later; otherwise, the tool is unavailable.\n\n## Video-Tutorials \n\n- : FreeCad 0.18 PART WB using SLICE and SLICE APART (English language), author: Ha Gei\n\n- : FreeCAD Slice und Slice Apart und andere Tricks (German lanuage), author: Ha Gei\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Part_Workbench.md) > Part SliceApart\n"} {"id": "freecad-docs:wiki/Path_Postprocessor_Customization.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_Postprocessor_Customization.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_Postprocessor_Customization.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7424f2b6e13e3f28d6d147043746f81a1698f76c5463f237635bd86cc16a7770", "bytes": 200, "tokens": 65, "text": "# Path Postprocessor Customization\n1. REDIRECT [CAM_Postprocessor_Customization](CAM_Postprocessor_Customization.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path Postprocessor Customization\n"} {"id": "freecad-docs:wiki/Path_Probe.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_Probe.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_Probe.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b7addd4e3cdb4663ddf5315a5c390804c8bd696543549baec5ba3b494b5388c8", "bytes": 112, "tokens": 53, "text": "# Path Probe\n1. REDIRECT [CAM_Probe](CAM_Probe.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path Probe\n"} {"id": "freecad-docs:wiki/Path_Profile.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_Profile.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_Profile.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4220587d23ea0444f112b6e36b2f33735d10f93198372089760dbc4207079f90", "bytes": 120, "tokens": 51, "text": "# Path Profile\n1. REDIRECT [CAM_Profile](CAM_Profile.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path Profile\n"} {"id": "freecad-docs:wiki/Path_Tools.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Path_Tools.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Path_Tools.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "18c78d2b6d9fe40a4de28befc7f6d2f278c2a7c5fc85a11bd6122986607ee75c", "bytes": 112, "tokens": 51, "text": "# Path Tools\n1. REDIRECT [CAM_Tools](CAM_Tools.md)\n\n\n---\n⏵ [documentation index](../README.md) > Path Tools\n"} {"id": "freecad-docs:wiki/Placement.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Placement.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Placement.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ce255016411db2e2c6ccb7d0f552c399f20ae5e782fc998b4b6cac208b7f6834", "bytes": 18966, "tokens": 5595, "text": "# Placement\n## Overview\n\n**Placement** is how FreeCAD specifies the location and attitude (orientation) of an object in space. Placement can be specified in multiple forms and manipulated via [scripting](Python_scripting_tutorial#Vectors_and_placements.md), the [property editor](Property_editor.md) or selecting **Edit → Placement...** to open the [Placement task panel](Std_Placement.md).\n\n### Accessing the Placement Attribute \n\nAn object\\'s Placement attributes can be accessed and modified in 3 ways:\n\n![Placement in property editor](images/PlacementPropertiesv10-800x800.png ) \n\n![Scripting Placement as y/p/r and Matrix and its [API](images/Placement_API.md).](PlacePyConv10.png ) \n\n![Placement task panel](images/PlacementDialogv10.png ) \n\n## Forms of Placement \n\nThe placement is stored internally as a position and a rotation (rotation axis and angle transformed into a [quaternion](https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation)). While there are several forms to specify a rotation, for instance with a rotation center, this is only used to affect the rotation computation and is not stored for later operations. Similarly, if a rotation axis of (1,1,1) is specified, it may be normalized when stored in the quaternion and appear as (0.58, 0.58, 0.58) when browsing the object later.\n\n### Angle, Axis and Position \n\n**Placement = \\[Angle, Axis, Position\\]**\n\nThe first form of **Placement** fixes an object\\'s location in space with a Position, and describes its orientation as a single rotation about an axis.\n\n**Angle = r** is a scalar indicating the amount of rotation of the object about **Axis**. Entered as degrees, but stored internally as radians.\n\n**Axis = (ax,ay,az)** is a vector describing an axis of rotation (See Note about axis of rotation). Examples are:\n\n(1,0,0) ==\\> about **X** axis\n\n   (0,1,0)       ==> about **Y** axis\n   (0,0,1)       ==> about **Z** axis\n   (0.71,0.71,0) ==> about the line **y=x**\n\nNote that it is also possible to translate (move) an object along this axis of rotation (axial motion) by entering the distance to move in the {{SpinBox|Axial: 0.0mm}} spinbox and clicking **Apply axial**. (One way to envision axial motion is to think of an airplane with a propeller spinning on its nose \\-- the propeller spins *about* an axis of rotation while the plane moves *along* that same axis.) The values in the vector can be thought of as the relative amount of motion that will be applied in that direction. For example, in the y=x case (0.71,0.71,0) the value contained in the Axial spinbox gets applied in equal measure to the X and Y directions, but no movement happens in the Z direction.\n\n**Position = (x,y,z)** is a Vector describing the point from which the object\\'s geometry will be calculated (in effect, a \\\"local origin\\\" for the object). Note that in scripts, Placement.Base is used to denote the Position component of a placement. The property editor calls this value **Position** and the Placement task panel calls it **Translation**.\n\n### Position and Yaw, Pitch and Roll \n\n![Placement task panel: {{ComboBox|Euler angles}} selected](images/PlacementDialogv10b.png ) \n\n**Placement = \\[Position, Yaw-Pitch-Roll\\]**\n\nThe second form of **Placement** fixes an object\\'s location in space with a **Position** (as in the first form), but describes its orientation using [Yaw, Pitch and Roll angles](http://en.wikipedia.org/wiki/Yaw,_pitch,_and_roll). These angles are sometimes referred to as [Euler angles](http://en.wikipedia.org/wiki/Euler_angles) or Tait-Bryan angles. Yaw, Pitch and Roll are common aviation terms for a body\\'s orientation (or attitude).\n\n**Position = (x,y,z)** is a Vector describing the point from which the object\\'s geometry will be calculated (in effect, a \\\"local origin\\\" for the object).\n\n**Yaw-Pitch-Roll = (y,p,r)** is a tuple that specifies the attitude of the object. Values for y,p,r specify degrees of rotation about each of the z,y,x axis (see note).\n\n \n```python\n>>> App.ActiveDocument.Cylinder.Placement = App.Placement(App.Vector(0,0,0), App.Rotation(10,20,30), App.Vector(0,0,0))\n```\n\nApp.Rotation(10,20,30) = Euler Angle\n\n**Yaw** = 10 degrees (**Z**)\n\n**Pitch** = 20 degrees (**Y**)\n\n**Roll** = 30 degrees (**X**)\n\n![](images/Tache_Placement_Lacet_fr_Mini.gif )**Yaw** is the rotation about the **Z axis**, that is to say a rotation from left to right.\n(The yaw angle is the **Psi ψ**). \n\n![](images/Tache_Placement_Tangage_fr_Mini.gif )**Pitch** is rotation about the **Y axis**, that is to say nose-up and nose-down.\n(The Pitch angle is the **Phi φ**). \n\n![](images/Tache_Placement_Roulis_fr_Mini.gif )**Roll** is rotation about the **X axis**, that is to say wing up and down.\n(The Roll angle is the **Thêta θ**). \n\n### Matrix\n\n**Placement = Matrix**\n\nThe third form of **Placement** describes the object\\'s position and orientation with a 4x4 affine transformation matrix ([Affine Transformation](http://en.wikipedia.org/wiki/Affine_transformation)).\n\n**Matrix** =\n\n  ((r11,r12,r13,t1),\n   (r21,r22,r23,t2),\n   (r31,r32,r33,t3),\n   (0,0,0,1)) , with rij specifying rotation and ti specifying translation.\n\n\n## The Placement Dialog \n\nThe Placement Dialog is invoked from the **Edit** menu. It is used to precisely rotate/translate objects. It is also used when we need to create a sketch on a \\\"non standard\\\" plane or change a sketch\\'s orientation to a new plane.\n\n- The **Translation** section adjusts the object\\'s location in space.\n- The **Center** section adjusts the rotational axis to one that does not pass through the object\\'s reference point.\n- The **Rotation** section adjusts the rotational angle(s) and the method of specifying those angles.\n\nBut while the elements within each section generally apply to the purpose of that section there are also some elements in one section that can affect elements in another section. For example, clicking the Selected points button in the **Center** section with 2 points selected in the 3d view results in not only populating the **Center** coordinate spinboxes with the coordinates of the midpoint between those 2 selected points, but it also creates a custom axis along the line defined by those 2 selected points in the **Rotation** section. In another example, placing a value in the Axial spinbox and clicking the Apply axial button in the **Translation** section translates (moves) the object along the axis defined in the **Rotation** section.\n\nThe **Apply incremental changes to object placement** tick box is useful when translations/rotations are to be made relative the object\\'s current position/attitude, rather than to the original position/attitude. Ticking this box resets the dialogue input fields to zero, but does not change the object\\'s orientation or location. Subsequent entries do change the orientation/location, but are applied from the object\\'s current position. Enabling this checkbox is also useful when using the Selected points button as it can sometimes prevent undesired placement changes.\n\nPS: since version 0.17 introduce new object Part, this object have his placement, and the Placement object created in the Part object is incremented with the Part Placement. (v0.17) \n\nTo obtain the Part Placement use this code:\n\n \n```python\nimport Draft, Part\nsel = FreeCADGui.Selection.getSelection()\nprint(sel[0].Placement)\nprint(sel[0].getGlobalPlacement()) # return the GlobalPlacement\nprint(sel[0].getParentGeoFeatureGroup()) # return the GeoFeatureGroup, ex: Body or a Part.\nprint(\"____________________\")\n```\n\n**Selected points** button is used to populate the coordinates in the **Center** coordinates spinboxes and (when 2 or 3 points are selected) additionally to create a custom (user-defined) axis of rotation in the **Rotation** section. A point can be a vertex, but it can also be any point along an edge or on a face. When you select an edge or face the entire edge or face is selected, but FreeCAD also remembers which point on that face or edge the mouse pointer was hovering over when that edge or face was selected. It is this point\\'s coordinates that get used in the Placement dialog when the **Selected points** button is clicked. You might be thinking this isn\\'t a very precise way of selecting a point, and you are correct, but in many cases it is sufficient that the point selected is guaranteed to be on that edge or face. In cases where you need to precisely designate a point to be used you should select a vertex. When there is no vertex in the desired location consider creating one, perhaps in a temporary sketch attached to that face or edge, perhaps using a Draft workbench object, such as a line or point, etc.\n\nLet us first consider the simple case of selecting 1 point. The workflow is to first select the desired point, then click the **Selected points** button. The coordinates of the selected point will be used to populate the X, Y, and Z spinboxes within the **Center** section. Now any rotation done on the object will about this center of rotation.\n\nNow consider the case of selecting 2 points. You would select the 2 desired points, and then click the **Selected points** button. The coordinates of the midpoint between the 2 selected points get placed into the X, Y, and Z spinboxes within the **Center** section. Now any rotation done on the object will be about this center of rotation. But in addition to setting up the **Center** section coordinates a custom (user-defined) axis is also added to the **Axis** element within the **Rotation** section. (Note: if you were in Euler rotation mode, the mode gets switched to Rotation with an axis mode and the new custom axis is selected as the current axis of rotation.) Now any rotation done using the new custom axis will be about this axis of rotation. As an added bonus, the distance is measured between the 2 selected points, and this information is given in the Report View. (Note: Hold down the Shift key while clicking the **Selected points** button to copy the distance measurement to the clipboard.) By entering this distance into the Axial spinbox in the **Translation** section and clicking the **Apply axial** button you can translate (move) the object so that the first selected point now occupies the coordinates occupied by the second selected point (at the time the **Selected points** button was clicked).\n\nNow consider the case of selecting 3 points. You would select the 3 desired points, and then click the **Selected points** button. The coordinates of the first selected point (order of selection is very important here) get placed into the X, Y, and Z spinboxes within the **Center** section. Since 3 points define a plane FreeCAD is able to take advantage of that and use those 3 points to create a new custom (user-defined) axis of rotation that is normal (perpendicular) to that defined plane. As with 2 selected points, the distance between points is also shown in the Report View, but this time it is the distance between the 2nd and 3rd selected points. (Note: Hold down the Shift key while clicking **Selected points** button \\-- Shift + Click \\-- to copy the angle measurement to the clipboard.) Additionally, the angle between the 2nd and 3rd points is also measured and displayed in the Report View. By entering this angle into the **Angle** spinbox within the **Rotation** section we can very precisely rotate the object such that now the 2nd selected point is in alignment with the coordinates occupied by the 3rd selected point. (Note: you might want to increase the number of digits used within the Edit menu -\\> Preferences -\\> General -\\> Units -\\> Number of decimals spinbox if you desire more precision.)\n\n## Examples\n\nRotations about a single axis:\n\n\"Before Before Rotation (top view) \n\n\"After After Rotation about Z (top view) \n\n\"After After Rotation about y=x (right view) \n\nRotation with offset centre point:\n\n\"Before Before Rotation (top view) \n\n\"After After Rotation about Z (top view) \n\nRotation using Euler angles:\n\n\"Before Before Rotation \n\n\"After After Rotation \n\n## Placement.Base vs Shape Definition \n\nPlacement is not the only way to position a shape in space. Note the Python console in this image:\n\n![2 Shapes with Same Placement](images/2Placements800.png ) \n\nBoth cubes have the same value for Placement, but are in different locations! This is because the 2 shapes are defined by different vertices (curves in more complex shapes). For the 2 shapes in the above illustration:\n\n\\>\\>\\> ev = App.ActiveDocument.Extrude.Shape.Vertexes\n\n >>> for v in ev: print(v.X,\",\",v.Y,\",\",v.Z)\n ...\n 30.0,30.0,0.0\n 30.0,30.0,10.0\n 40.0,30.0,0.0\n 40.0,30.0,10.0\n 40.0,40.0,0.0\n 40.0,40.0,10.0\n 30.0,40.0,0.0\n 30.0,40.0,10.0\n >>> e1v = App.ActiveDocument.Extrude001.Shape.Vertexes\n >>> for v in e1v: print(v.X,\",\",v.Y,\",\",v.Z)\n ...\n 0.0,10.0,0.0\n 0.0,10.0,10.0\n 10.0,10.0,0.0\n 10.0,10.0,10.0\n 10.0,0.0,0.0\n 10.0,0.0,10.0\n 0.0,0.0,0.0\n 0.0,0.0,10.0\n >>>\n\nThe Vertices (or Vectors) that define the shape use the Placement.Base attribute as their origin. So if you want to move a shape 10 units along the **X** axis, you could add 10 to the **X** coordinates of all the Vertices or you could set Placement.Base to (10,0,0).\n\n## Using \\\"Center\\\" to Control Axis of Rotation \n\nBy default, the axis of rotation isn\\'t really the x/y/z axis. It is a line parallel to the selected axis, but passing through the reference point (Placement.Base) of the object to be rotated. This can be changed by using the Center fields in the Placement dialog or, in scripts, by using the Center parameter of the FreeCAD.Placement constructor.\n\nFor example, suppose we have a box (below) positioned at (20,20,10).\n\n![Before Rotation](images/LocalZBefore2.png ) \n\nWe wish to spin the box around it\\'s own vertical centre line (ie local Z), while keeping it the same position. We can easily achieve this by specifying a Center value equal to the coordinates of the box\\'s central point (25,25,15).\n\n![After Rotation](images/LocalZAfter2.png ) \n\nIn a script, we would do:\n\n \n```python\nimport FreeCAD\nobj = App.ActiveDocument.Box # our box\nrot = FreeCAD.Rotation(FreeCAD.Vector(0,0,1),45) # 45° about Z\n#rot = FreeCAD.Rotation(FreeCAD.Vector(1,0,1),45) # 45° about X and 45° about Z\n#rot = FreeCAD.Rotation(10,20,30) # here example with Euler angle Yaw = 10 degrees (Z), Pitch = 20 degrees (Y), Roll = 30 degrees (X)\ncentre = FreeCAD.Vector(25,25,15) # central point of box\npos = obj.Placement.Base # position point of box\nnewplace = FreeCAD.Placement(pos,rot,centre) # make a new Placement object\nobj.Placement = newplace # spin the box\n```\n\nSame script with the file example [RotateCoG2.fcstd](http://forum.freecadweb.org/download/file.php?id=1651) (discussion on the [forum](http://forum.freecadweb.org/viewtopic.php?f=3&t=3950#p31052))\n\n \n```python\nimport FreeCAD\nobj = App.ActiveDocument.Extrude # our box\nrot = FreeCAD.Rotation(FreeCAD.Vector(0,0,1),45) # 45 about Z\n#rot = FreeCAD.Rotation(FreeCAD.Vector(1,0,1),45) # 45° about X and 45° about Z\n#rot = FreeCAD.Rotation(10,20,30) # here example with Euler angle Yaw = 10 degrees (Z), Pitch = 20 degrees (Y), Roll = 30 degrees (X)\ncentre = FreeCAD.Vector(25,25,0) # \"centre\" of rotation (where local Z cuts XY)\npos = obj.Placement.Base # original placement of obj\nnewplace = FreeCAD.Placement(pos,rot,centre) # make a new Placement object\nobj.Placement = newplace # spin the box\n```\n\n## Using Placement in expressions \n\nIn expressions it is possible to use the components of the placement for example to access the x-component of the object labeled \\\"Cube\\\":\n\n \n```python\n<>.Placement.Base.x\n```\n\nYou can access the angle of the rotation by\n\n \n```python\n<>.Placement.Rotation.Angle\n```\n\nThe axis of rotation can be accessed with\n\n \n```python\n<>.Placement.Rotation.Axis.x\n<>.Placement.Rotation.Axis.y\n<>.Placement.Rotation.Axis.z\n```\n\nwhere often one of these values is 1 while the others are 0.\n\nYou can also use the whole Placement in a single expression:\n\nRight click on Placement property in the property editor, select \\\"show all\\\" then extra properties will show. If you then right click on Placement again the context menu will include Expression, select Expression then the Expression dialogue will open and whatever you type will go into the Placement property rather than its child properties.\n\nTo make the placement of \\\"Sketch\\\" equal to that of \\\"Cylinder\\\", you would enter in that way for Sketch the expression\n\n \n```python\n<>.Placement\n```\n\n![Setting the whole Placement in one expression](images/PlacementInExpression.png ) \n\n**NOTE:** It\\'s also possible to *create* Placement objects in expressions. See the [Expressions](Expressions#Placement.md) page for details.\n\n## Notes\n\n- The Placement properties in the Data tab are disabled for objects which are attached to some other object. The Attachment Offset has to be edited instead.\n- Axis and Angle can also be expressed as a [quaternion](http://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation).\n- The reference point of an object varies depending on the object. Some examples for common objects:\n\n Object Reference Point\n \n Part.Box left (minx), front (miny), bottom (minz) vertex\n Part.Sphere center of the sphere (ie centre of bounding box)\n Part.Cylinder center of the bottom face\n Part.Cone center of bottom face (or apex if bottom radius is 0)\n Part.Torus center of the torus\n Features derived from Sketches the Feature inherits the Position of the underlying Sketch. Sketches always start with Position = (0,0,0). This position corresponds to the origin in the sketch.\n\n## More\n\n- This tutorial: [Aeroplane](Aeroplane.md) covers the mechanics of changing an object\\'s Placement extensively.\n- This [FreeCAD News article](https://blog.freecad.org/2023/01/16/the-rotation-api-in-freecad/?preview_id=343) discusses the Rotation API.\n\n\n---\n⏵ [documentation index](../README.md) > Placement\n"} {"id": "freecad-docs:wiki/Python.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Python.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Python.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "524b7c072838cba62ea8463ad3379276e30b45d4b7abc5143117a97a2f607b60", "bytes": 4767, "tokens": 1440, "text": "# Python\n## Description\n\n[Python](https://www.python.org) is a general purpose, high level programming language that is very commonly used in large applications to automate some tasks by creating scripts or [macros](macros.md).\n\nIn FreeCAD, Python code can be used to create various elements programmatically, without needing to click on the graphical user interface. Additionally, many tools and workbenches of FreeCAD are programmed in Python.\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 start scripting in FreeCAD.\n\n## Readability\n\nReadability of Python code is one of the most important aspects of this language. Using a clear and consistent style within the Python community facilitates contributions by different developers, as most experienced Python programmers expect the code to be formatted in a certain way and to follow certain rules. When writing Python code, it is advisable to follow [PEP8: Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/) and [PEP257: Docstring Conventions](https://www.python.org/dev/peps/pep-0257/).\n\nThese documents present explanations in a more user-friendly way:\n\n- [How to Write Beautiful Python Code With PEP 8](https://realpython.com/python-pep8/)\n- [Documenting Python Code: A Complete Guide](https://realpython.com/documenting-python-code/).\n\n## Conventions\n\nIn this documentation, some conventions for Python examples should be followed.\n\nThis is a typical function signature \n\n\n```python\nWire = make_wire(pointslist, closed=False, placement=None, face=None, support=None)\n```\n- Arguments with key-value pairs are optional, with the default value indicated in the signature. This means that the following calls are equivalent:\n\n\n```python\nWire = make_wire(pointslist, False, None, None, None)\nWire = make_wire(pointslist, False, None, None)\nWire = make_wire(pointslist, False, None)\nWire = make_wire(pointslist, False)\nWire = make_wire(pointslist)\n```\n\n\n: In this example the first argument doesn\\'t have a default value so it should always be included.\n\n- When the arguments are given with the explicit key, the optional arguments can be given in any order. This means that the following calls are equivalent:\n\n \n```python\nWire = make_wire(pointslist, closed=False, placement=None, face=None)\nWire = make_wire(pointslist, closed=False, face=None, placement=None)\nWire = make_wire(pointslist, placement=None, closed=False, face=None)\nWire = make_wire(pointslist, support=None, closed=False, placement=None, face=None)\n```\n\n- Python\\'s guidelines stress readability of code; in particular, parentheses should immediately follow the function name, and a space should follow a comma.\n\n\n```python\np1 = Vector(0, 0, 0)\np2 = Vector(1, 1, 0)\np3 = Vector(2, 0, 0)\nWire = make_wire([p1, p2, p3], closed=True)\n```\n- If code needs to be broken over several lines, this should be done at a comma inside brackets or parentheses; the second line should be aligned with the previous one.\n\n\n```python\na_list = [1, 2, 3,\n 2, 4, 5]\n\nWire = make_wire(pointslist,\n False, None,\n None, None)\n```\n- Functions may return an object that can be used as the base of another drawing function.\n\n \n```python\nWire = make_wire(pointslist, closed=True, face=True)\nWindow = make_window(Wire, name=\"Big window\")\n```\n\n## Imports\n\nPython functions are stored in files called modules. Before using any function in that module, the module must be included in the document with the `import` instruction.\n\nThis creates prefixed functions, that is, `module.function()`. This system prevents name clashes with functions that are named the same but that come from different modules. For example, the two functions `Arch.make_window()` and `myModule.make_window()` may coexist without problem.\n\nFull examples should include the necessary imports and the prefixed functions.\n\n \n```python\nimport FreeCAD as App\nimport Draft\n\np1 = App.Vector(0, 0, 0)\np2 = App.Vector(1, 1, 0)\np3 = App.Vector(2, 0, 0)\nWire = Draft.make_wire([p1, p2, p3], closed=True)\n```\n\n\n```python\nimport FreeCAD as App\nimport Draft\nimport Arch\n\np1 = App.Vector(0, 0, 0)\np2 = App.Vector(1, 0, 0)\np3 = App.Vector(1, 1, 0)\np4 = App.Vector(0, 2, 0)\npointslist = [p1, p2, p3, p4]\n\nWire = Draft.make_wire(pointslist, closed=True, face=True)\nStructure = Arch.make_structure(Wire, name=\"Big pillar\")\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [API](Category_API.md) > [Python Code](Category_Python%20Code.md) > [Glossary](Category_Glossary.md) > Python\n"} {"id": "freecad-docs:wiki/Raytracing_API_example.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Raytracing_API_example.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Raytracing_API_example.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1d56a05a3120c5b1897054a2975f5159acd70ee46d6eef77b45871a2e071047c", "bytes": 2656, "tokens": 895, "text": "# Raytracing API example\n## Introduction\n\nThe `Raytracing` and `RaytracingGui` modules provide several methods to write scene contents as povray or luxrender data.\n\nThe most useful commands are `Raytracing.getPartAsPovray()` and `Raytracing.getPartAsLux()` to render a FreeCAD Part object into a povray or luxrender definition, and `RaytracingGui.povViewCamera()` and `RaytracinGui.luxViewCamera()` to get the current point of view of the 3D view window into povray or luxrender format.\n\n## Outputting render files \n\nHere is how to write a povray file from python, assuming your document contains a \\\"Box\\\" object:\n\n \n```python\nimport Raytracing,RaytracingGui\nOutFile = open('C:/Documents and Settings/jriegel/Desktop/test.pov','w')\nOutFile.write(open(App.getResourceDir()+'Mod/Raytracing/Templates/ProjectStd.pov').read())\nOutFile.write(RaytracingGui.povViewCamera())\nOutFile.write(Raytracing.getPartAsPovray('Box',App.activeDocument().Box.Shape,0.800000,0.800000,0.800000))\nOutFile.close()\ndel OutFile\n```\n\nAnd the same for luxrender:\n\n \n```python\nimport Raytracing,RaytracingGui\nOutFile = open('C:/Documents and Settings/jriegel/Desktop/test.lxs','w')\nOutFile.write(open(App.getResourceDir()+'Mod/Raytracing/Templates/LuxClassic.lxs').read())\nOutFile.write(RaytracingGui.luxViewCamera())\nOutFile.write(Raytracing.getPartAsLux('Box',App.activeDocument().Box.Shape,0.800000,0.800000,0.800000))\nOutFile.close()\ndel OutFile\n```\n\n## Creating a custom render object \n\nApart from standard povray and luxrender view objects that provide a view of an existing Part object, and that can be inserted in povray and luxrender projects respectively, a third object exist, called RaySegment, that can be inserted either in povray or luxrender projects. That RaySegment object is not linked to any of the FreeCAD objects, and can contain custom povray or luxrender code, that you might wish to insert into your raytracing project. You can also use it, for example, to output your FreeCAD objects a certain way, if you are not happy with the standard way. You can create and use it like this from the python console:\n\n \n```python\nmyRaytracingProject = FreeCAD.ActiveDocument.PovProject\nmyCustomRenderObject = FreeCAD.ActiveDocument.addObject(\"Raytracing::RaySegment\",\"myRenderObject\")\nmyRaytracingProject.addObject(myCustomRenderObject)\nmyCustomRenderObject.Result = \"// Hello from python!\"\n```\n\n {{Raytracing Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [API](Category_API.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Python Code](Category_Python%20Code.md) > [Raytracing](Category_Raytracing.md) > Raytracing API example\n"} {"id": "freecad-docs:wiki/Rocket_RailGuide.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Rocket_RailGuide.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Rocket_RailGuide.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "14d3cab41a3532b3632f6528c2bb65c70d9dd7c7f694b944fd2eab4b825ca148", "bytes": 1722, "tokens": 584, "text": "---\n GuiCommand:\n Name: Rocket RailGuide\n MenuLocation: Rocket , Launch Guides , Rail Guide\n Workbenches: Rocket_Workbench\n Version: 0.19\n---\n\n# Rocket RailGuide\n\n## Description\n\nA rail guide is a component attached to the side of the rocket that allows the rocket to be guided using a rail until it is fast enough to be aerodynamically stable.\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Rail Guide](Rocket_RailGuide.md)** button.\n - Select the **Rocket → Launch Guides→ Rail Guide** option from the menu.\n - Double click on a Rail Guide object in the [Tree view](Tree_view.md).\n2. Set options and press **OK**.\n\n## Properties\n\n\n{{TitleProperty|Rail Guide}}\n\n- **Aft Sweep**:\n\n- **Aft Sweep Angle**:\n\n- **Auto Diameter**:\n\n- **Base Thickness**:\n\n- **Base Width**:\n\n- **Diameter**:\n\n- **Forward Sweep**:\n\n- **Forward Sweep Angle**:\n\n- **Length**:\n\n- **Middle Width**:\n\n- **Notch**:\n\n- **Notch Depth**:\n\n- **Notch Width**:\n\n- **Rail Guide Base Type**:\n\n- **Thickness**:\n\n- **Top Thickness**:\n\n- **Top Width**:\n\n- **VAngle**:\n\n\n{{TitleProperty|Rocket Component}}\n\nThese parameters are provided for information and have no effect on the design of the component.\n\n- **Description**: Description of the component\n\n- **Manufacturer**: Manufacturer when known\n\n- **Material**: Material when known\n\n- **Part Number**: Manufacturer part number\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > Rocket RailGuide\n"} {"id": "freecad-docs:wiki/Sandbox_TutorialArchBIM.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sandbox_TutorialArchBIM.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sandbox_TutorialArchBIM.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "52fb9b67c660b6a3a09e8c0b1435caa4d9290538d2e7d4b91433d73a1fb6fe97", "bytes": 71801, "tokens": 23459, "text": "---\n TutorialInfo:n\n Topic: Modeling\n Level: Intermediate\n Time: Indefinate\n Author: User:cadgiru\n FCVersion: 0.17\n Files: \n---\n\n# Sandbox:TutorialArchBIM\n\n\n![800 px](images/At2_goal.jpg )\n\n- [João Batista Vilanova Artigas](http://en.wikipedia.org/wiki/Jo%C3%A3o_Batista_Vilanova_Artigas)\n- [Pictures by Pedro Kok](http://www.pedrokok.com.br/2010/02/residencia-artigas-sao-paulo-sp/img_8258-533px/)\n- [Barão de Jaceguaí, 1151 - Campo Belo, São Paulo-SP (Google)](https://www.google.com/maps/place/Vilanova+Artigas/@-23.62048,-46.6751798,3a,75y,163.84h,67.09t/data=!3m8!1e1!3m6!1sAF1QipOpcWfw3qit1I979azjBmYbIrUqv_cMe593_e69!2e10!3e11!6shttps:%2F%2Flh5.googleusercontent.com%2Fp%2FAF1QipOpcWfw3qit1I979azjBmYbIrUqv_cMe593_e69%3Dw203-h100-k-no-pi-17.99819-ya18.417234-ro1.3375344-fo100!7i5376!8i2688!4m13!1m7!3m6!1s0x94ce509f4a47bb0f:0xd7dfecff13fd4b4!2sRua+Bar%C3%A3o+Jaceguai,+1151+-+Campo+Belo,+S%C3%A3o+Paulo+-+SP,+04606-000,+Brasil!3b1!8m2!3d-23.6205562!4d-46.6751216!3m4!1s0x94ce509f497a12cd:0xe62a63ce23f77686!8m2!3d-23.62048!4d-46.6751798) With 30 images\n- [Completed Freecad model by Wilson, as above image](https://github.com/FreeCAD/Examples/blob/master/at2_Examples/ref/2dReferenceComplete.fcstd)\n\n## Goal of this document \n\nUpdate original [Arch Tutorial](Arch_tutorial.md) by [Yorik van Havre](http://yorik.uncreated.net/) .\n\n- Reflect version updated versions of Freecad (Currently 0.17 / 0.18 )\n- Implement a BIM workflow\n\nCurrently this document is **WORK in Progress**\n\n### Contributors\n\n \n [Yorik van Havre](http://yorik.uncreated.net/) Main developer of Arch Workbench, and original author of this document\n [Peter Sande](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=10838) Initiator and co-author of this update. Freecad 0.17 / 0.18 in summer / fall of 2018. The purpose was to seriously try to learn some Freecad Work flows, after playing with it at various points in time over at least the last 5 years.\n [Wilson](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=20694) \n Other In order to make this a working document we need additional users\n \n\n### Conventions\n\n#### Example Files \n\nReference Files used in this tutorial are named as:\n\n\n{{Code|\nat2_Name\n────\n│ ─── \n│ │\n│ └── SomeMeaningfulName \n│\n└── 4 Char prefix\n at2_ -> Arch Tutorial 2 \n}}\n\n[Link to example files for this tutorial](https://github.com/FreeCAD/Examples/tree/master/at2_Examples)\n\n#### Images\n\nAll Images not already on wiki are named and uploaded to *\\**\n\n#### Markups\n\n- ![](images/At2_Fixme.gif )FIXME Comment\n - When something needs a closer look, rewrite or other..\n- ![](images/At2_Tip.png )Tip\n- ![](images/At2_Delete.gif )Delete ?\n - Something You think should be deleted\n\nThis way it is easy to do a quick text search to find topics of concern\n\n## Introduction\n\nThis tutorial aims at giving you the basics to work with the [Arch Workbench](Arch_Workbench.md). I will try to make it simple enough so you don\\'t need any previous experience with FreeCAD, but having some experience with 3D or [BIM](http://en.wikipedia.org/wiki/Building_Information_Modeling) applications will be useful. In any case, you should be prepared to look for yourself for further information about how FreeCAD works on the [FreeCAD documentation wiki](Main_Page.md). The [Getting started](Getting_started.md) page is a must read, if you have no previous experience with FreeCAD. Also check our [tutorials](tutorials.md) section, and on [youtube](http://www.youtube.com/results?search_query=freecad) you will also find a lot more of FreeCAD tutorials.\n\nThe purpose of the [Arch Workbench](Arch_Workbench.md) is to offer a complete [BIM](http://en.wikipedia.org/wiki/Building_Information_Modeling) workflow inside FreeCAD. As it is still under development, don\\'t expect to find here the same tools and level of completion as grown-up commercial alternatives such as [Revit](http://en.wikipedia.org/wiki/Revit) or [ArchiCAD](http://en.wikipedia.org/wiki/Archicad), but on the other hand, FreeCAD being used in a much bigger scope than these applications, the [Arch Workbench](Arch_Workbench.md) greatly benefits from the other disciplines FreeCAD caters to, and offers some features rarely seen in traditional BIM applications.\n\nHere are, for example, a couple of interesting features of FreeCAD\\'s [Arch Workbench](Arch_Workbench.md) that you\\'ll hardly find in other BIM apps:\n\n- ![](images/At2_Fixme.gif )FIXME ***The next sentence, is that strictly true?*** Architectural objects are always solids. From FreeCAD\\'s strong mechanical background, we learned the importance of always working with solid objects. This ensures a much more error-free workflow, and very reliable boolean operations. Since cutting through 3D objects with a 2D plane, in order to extract sections, is also a boolean operation, you can immediately see the importance of this point.\n\n- Architectural objects can always have any shape. No restrictions. Walls don\\'t need to be vertical, slabs don\\'t need to look like slabs. Any solid object can always become any architectural object. Very complex things, usually hard to define in other BIM applications, like a floor slab curving up and becoming a wall (yes Zaha Hadid, it\\'s you we\\'re talking about), present no particular problem at all in FreeCAD.\n\n- The whole power of FreeCAD is at your fingertips. You can design architectural objects with any other tool of FreeCAD, such as the [PartDesign Workbench](PartDesign_Workbench.md), and when they are ready, convert them to architectural objects. They will still retain their full modeling history, and continue being totally editable. The [Arch Workbench](Arch_Workbench.md) also inherits much of the [Draft Workbench](Draft_Workbench.md) functionality, such as [snapping](Draft_Snap.md) and [working planes](Draft_SelectPlane.md).\n\n- The [Arch Workbench](Arch_Workbench.md) is very [mesh](Mesh_Workbench.md)-friendly. You can easily design an architectural model in a mesh-based application such as [Blender](http://en.wikipedia.org/wiki/Blender_%28software%29) or [SketchUp](http://en.wikipedia.org/wiki/Sketchup) and import it in FreeCAD. If you took care of the quality of your model and its objects are manifold solid shapes, turning them into architectural objects only requires the press of a button.\n\nAt the time of writing, the [Arch Workbench](Arch_Workbench.md), as the rest of FreeCAD, suffers some limitations. Most are being worked on, and will disappear in the future.\n\n- FreeCAD is no 2D application. It is made for 3D. There is a reasonable set of tools for drawing and editing 2D objects with the [Draft Workbench](Draft_Workbench.md) and [Sketcher Workbench](Sketcher_Workbench.md), but it is not made for handling very large (and sometimes badly drawn) 2D CAD files. You can usually successfully import 2D files, but don\\'t expect very high performance if you want to keep working on them in 2D. You have been warned.\n\n- No materials support. FreeCAD will have a complete [Material](Material.md) system, able to define very complex materials, with all the goodies you can expect (custom properties, material families, rendering and visual aspect properties, etc), and the [Arch Workbench](Arch_Workbench.md) will of course use it when it is ready.\n\n- Very preliminary [IFC](http://en.wikipedia.org/wiki/Industry_Foundation_Classes) support. You can already [import IFC files](Arch_IFC.md), quite reliably, provided [IfcOpenShell](http://ifcopenshell.org) is installed on your system, but exporting is still not officially supported. This is worked on both by the FreeCAD and IfcOpenShell developers, and in the future we can expect full-powered IFC support.\n\n- Most Arch tools are still in development. That means that automatic \\\"wizard\\\" tools that create complex geometry automatically, such as [Arch Roof](Arch_Roof.md) or [Arch Stairs](Arch_Stairs.md) can only produce certain types of objects, and other tools that have presets, such as [Arch Structure](Arch_Structure.md) or [Arch Window](Arch_Window.md) only have a couple of basic presets. This will of course grow over time.\n\n- [Units](Units.md) are being implemented in FreeCAD, which will allow you to work with any unit you wish (even imperial units, you guys from the USA can be eternally grateful for this to Jürgen, FreeCAD\\'s godfather and dictator). But at the moment the implementation is not complete, and the Arch workbench still doesn\\'t support them. You must consider it \\\"unit-less\\\". This tutorial uses **millimeters** as units.\n\n## Typical workflows \n\nIn this tutorial we focus on a BIM oriented approach of using FreeCad. We will use mostly three workbenches: [Arch Workbench](Arch_Workbench.md) and BIM, of course, but also Draft, whose tools are all included in Arch, so there is no need to switch workbenches, and Sketcher. Conveniently, You can create a custom toolbar in your Arch workbench, with Tools → Customize, and add the tools from the sketcher that you use often.\n\n## Preparation\n\nInstead of creating a project from scratch, let\\'s take an example project to model, it will save us time. We\\'ll use this wonderful house by the famous architect [Vilanova Artigas](http://en.wikipedia.org/wiki/Jo%C3%A3o_Batista_Vilanova_Artigas) (see a series of [pictures by Pedro Kok](http://www.pedrokok.com.br/2010/02/residencia-artigas-sao-paulo-sp/img_8258-533px/)), as used in the original FreeCAD Arch Tutorial made by [Yorik](http://yorik.uncreated.net/). It is simple, it\\'s a wonderful example of the amazing modernist architecture of São Paulo and the drawings are easily available. You can download drawings in dwg format [here](http://www.bibliocad.com/library/second-house-vilanova-artigas_72926#). To download the file, you\\'ll need to make a free registration on the website. In alternative, you can grab directly a DXF version [here](http://yorik.uncreated.net/scripts/artigas.dxf)) as a base to build our model. We recommend you to use DXF files instead of DWG, because FreeCAD handle those a lot better. Either way, is your decision.\n\nAfter downloading and unzipping the file, you\\'ll want to open it with a DWG application such as [DraftSight](http://www.3ds.com/products-services/draftsight/overview/). Alternatively, you can convert it to DXF with a free utility such as the [Teigha File Converter](http://www.opendesign.com/guestfiles/TeighaFileConverter). If you have the Teigha converter installed (and its path set in the Arch Preferences settings), [FreeCAD is also able to import DWG files directly](https://www.freecadweb.org/wiki/Draft_DXF). But since these files can sometimes be of bad quality and very heavy, it\\'s usually better to open it first with a 2D CAD application and do some cleaning. You should remove all the unnecessary information (title-blocks, page layouts, unused entities, layers, etc.) and organize the drawings in a logical way (sections and elevations aligned with the plan view, and move everything to the (0,0) point). After, you should organize your drawing it in different layers. This will be handy later on if you need to temporarily hide some of its elements to make it easy to model. This is the result when you import to FreeCAD after organizing the DXF in different layers:\n\n![](images/DXF_Import.jpg )\n\n![](images/At2_Tip.png ) Before importing your file, you want to make sure that you have the \\\"Group layers into blocks\\\" option selected. That way, each layer will be grouped as one object, making it easier to work within FreeCAD. To enable that option, you go to Edit \\> Preferences \\> Import-Export.\n\n![](images/At2_Tip.png ) Sometimes when importing DXF files into FreeCAD, the drawing may be out of scale. If that happens, open the DXF on a program such as Draftsight, create a new file and copy/paste all objects. After, just save it as a new DXF file, give it a new name and import it again into FreeCAD.\n\nYou could also organize your layers accordingly to the different elements that make up the project. By that I mean you could make a layer for the plan view, another for the south elevation, north elevation, and so on. Feel free to try out and find the way it suits you best or follow the suggestions above if you prefer.\n\nAfter that, our file can be opened quite efficiently in FreeCAD. Check the different options available in Edit → Preferences →\n\n![](images/Arch_tutorial_02.jpg )\n\nThis is how the file looks after being opened in FreeCAD. In this example, thickness of walls were changed, and a couple of doors that were imported with wrong X scale were flipped, with the [Draft Scaletool](Draft_Scale.md).\n\n## Preparing dwg / dxf Alternative text \n\nFor editing and exporting to dxf there are various free tools available. Like said before, one of free tools out there that works fine is [https://www.3ds.com/products-services/draftsight-cad-software/ DraftSight by Dassault](https://www.3ds.com/products-services/draftsight-cad-software/_DraftSight_by_Dassault.md).\n\nSometimes, the files you\\'ll use in your daily work can be in different units, since you\\'ll find people with different work methods. If when imported your drawing is e.g. in millimeters and you work in meters, just scale by 1000 (it will scale correctly on all axis), either in FC or other system.\n\nTo model your project using plan views, sections and elevations, another method can be used: you can separate your project in several dxf files. This will give you the possibility to rotate the drawings in FreeCAD and position them where you want, independent from one another, as well as to hide part of them while keeping others, if necessary. For that, you\\'ll need to create a .dxf file with the ground floor level, another with the level 1 (in the Artigas house, this corresponds to the studio), the north elevation, south elevation, section AA\\', BB\\', and so on. I would recommend you do this after the cleaning/organization process described before, to save you time and effort. Next, import all .dxf files to FreeCAD.\n\n**NOTE:** Notice that by importing different .dxf drawings to one file, you\\'ll be loading them as separate elements. In some computers, you might experience a slightly lower performance than if you would by importing just one .dxf file with all drawings. However, this option allows you to rotate and move these drawings independently from one another, to hide one elevation while keeping another, and so on. Besides, you can always hide all the imported elements and only keep the drawing you need for a particular operation, which will improve significantly your computer performance, if you have a problem with it. Experiment, give it a try and choose the work method that suits you better.\n\n![](images/At2_Tip.png )Tip You may also want to try to import or save the various views into separate [FCStd](File_Format_FCStd.md) files. This keeps the files smaller and quicker to work with. Naming of files is Your choice, but it is a good idea to use a naming convention.\n\nExample files produced at various levels of this tutorial will be placed on [GitHub FreeCad Examples at2_Examples](https://github.com/FreeCAD/Examples/tree/master/at2_Examples)\n\n*For dxf files, they are placed in a directory named ./ref/dxf below the project directory. If You want to skip this step, the imported dxf files can be found here.*\n\n### Plan View \n\nStart with importing and placing the Plan View.\n\n![](images/At2_PlanView.png )\n\nIf you don\\'t have the option \\\"Group layers into blocks\\\" selected, as suggested before, when importing your DXF file your geometry will show up as several edges. This can make FreeCAD run slower. However, depending on what you want to do, you may want to have your object divided in edges instead of grouped into blocks. Either way, make a good habit of organizing your file by compiling these edges into a [group](Std_Group.md). The Group can be created before or after importing. Once you have imported your .dxf file into FreeCAD, just select all the imported edges and 'drag/drop' them into the [group](Std_Group.md).\n\n![](images/At2_PlanGroup.png )\n\nNow, do the same for all the other views. Next in this document, we will place the various views at their location, elevation and rotation, according to our ArchAxisSystem. Before Rotating and placing the various views, we need to do some planning.\n\n![](images/At2_Tip.png )Tip\n\n![](images/At2_Fixme.gif )FIXME needs Checking\n\nFreeCad dxf import treats everything as Edges or Shapes, This is generally ok for lines. Bad for circles. No easy way to find Center.\n\n## Planning\n\n![](images/At2_Fixme.gif )FIXME Needs more work\n\nThere are no set rules for how to organize Your work. Having said that, planning always pays off. The following list contains some points to get You started.\n\n- [Define a project origin](#As_a_minimum.md)\n- [Define an Arch Axis System](#Defining_the_Arch_Axis_System.md)\n- Make appropriate as needed workplanes\n - Name everything something logical\n- Work with partial files\n - FC does not at current time support referenced attachments (often referred to as xrefs)\n - However, any selection, even [group(s)](Std_Group.md) in the [ComboView](Document_structure.md) can be copy / pasted between files\n - for this to work efficiently project origin is essential.\n - This is a great and not well documented feature of FreeCAD\n- Name Your various files logically\n - Define a naming convention for files, or You may soon get lost\n\nMost of the guidelines or rules proposed here, are common to any CAD system.\n\n### As a minimum \n\n**A defined project zero / origin -- with local x,y,z coordinates 0,0,0 shall be defined and used throughout the project.**\n\n![](images/At2_Tip.png )Tip\n\nFor further planning of File structure jump to the IFC section of this document\n\nIn this project we will follow Axis system of downloaded original Drawings.\n\n\"\"\n\nDefining the project origin at intersection of Axis 01 & D. By our convention this equals SouthWest corner of model. Observe that the axis pass through the center of walls.\n\nWhen modeling any Architectural model, You will most certainly want to split into separate files. By the way, partial IFC files seem to be the trend at the moment. Mainly split by discipline. The split can be by discipline or other. It is good practice to have a common origin and orientation across these models (files). This makes it easy to copy paste groups between files as needed. It also provides a good basis for several people to work on the project as needed.\n\n![](images/At2_Tip.png )Tip\n\nFor reference we have made the assumption that global Y-axis equals North.\n\n### Defining the Arch Axis System \n\nWe now want to make an [ArchAxisSystem](Arch_Axis/en.md) for reference when modeling our building. The result will look something like this:\n\n\"\"\n\nTo find the data for making the [ArchAxisSystem](Arch_Axis/en.md) study the Plan View of the imported dwg. This will show You Axis and Dimensions.\n\n\"\"\n\nAlternatively measure between the various axis in Freecad. This can be done in several ways, using the part workbench Measure linear, [Tape Measure works fine for this](Part_Measure_Linear.md).\n\n![](images/At2_metrics.png )\n\nBy Studying original dxf files.\n\n![](images/At2_AxisX11.png )\n\nWhen measuring distance between axis 10 and 11, we find Delta X = 3.6246 Index 11 above, has been adjusted since if possible, we like to work with 'round' figures.\n\n![](images/At2_ColumnsEast.JPG )\n\nWe also observe that the Eastern Columns are tangent to East wall of Studio. This is not good practice.\n\n![](images/At2_Fixme.gif )FIXME Comment\n\nWill reduce the distance between axis 10 and 11. Will try with 3550mm.\n\n#### Arch axis X  \n\nNow, let's make the Axis along global X: The Freecad Command is [Arch Axis ](Arch_Axis.md)\n\n\"\"\n\nImage shows Data and labels Used.\n\n#### Arch Y-Axis \n\n\"\"\n\nImage shows Data and labels Used.\n\n![](images/At2_Tip.png )Tip\n\nObserve the 270deg rotation and offset of placement to get labels to get desired layout.\n\n#### Combining to Axis System \n\nArch [AxisSystem](Arch_AxisSystem.md) is used to combine the x and y Arch Axis into an Arch Axis system.\n\n![](images/At2_Tip.png )Tip\n\nIf You save Your AxisSystem to a file, without any other geometry, it does not seem to open as the first file. FreeCad simply Crashes. However, not such a big deal, because if You open another file containing geometry first, then You are able to open the file containing only the AxisSystem without any problem. Strange??\n\n#### Axis System Forum posts \n\n- [Arch Axis question](https://forum.freecadweb.org/viewtopic.php?f=23&t=30938)\n\n## Placing and rotating 2d Views \n\nIn order to place 2d views in 3d, we need to prepare some helper objects. In FreeCad we have several ways we can set-up, store and name [Working Planes](Draft_SelectPlane.md) . We can name these and store them by using a [WorkingPlaneProxy object](Draft_WorkingPlaneProxy.md).\n\n\"\"\n\nYou should end up with something looking like this\n\n![](images/At2_Tip.png )Tip\n\nBy placing and rotating the imported 2d view, You will have a good way of checking their consistency.\n\n## Adding reference planes \n\n![](images/At2_Fixme.gif )FIXME needs documenting\n\nAfter starting to look at [#WokFeature_Approach](#WokFeature_Approach.md). Think this is a great way of implementing working planes.\n\n## Modeling\n\n### Walls\n\nWalls can be:\n\n- Inner / Outer, Structural / Non Structural\n- Walls should contain openings for doors, windows, or other\n\nLike most [Arch](Arch_Workbench.md) objects, [walls](Arch_Wall.md) can be built upon a big variety of other objects: [lines](Draft_Line.md), [wires](Draft_Wire.md) (polylines), [sketches](Sketcher_Workbench.md), faces or solid (or even on nothing at all, in which case they are defined by height, width and length). The resulting geometry of the wall depends on that base geometry, and the properties you fill in, such as width and height. As you might guess, a wall based on a line will use that line as its alignment line, while a wall based on a face will use that face as its base footprint, and a wall based on a solid will simply adopt the shape of that solid. This allows about any shape imaginable to become a wall.\n\nThere are different possible strategies to build walls in FreeCAD. One might want to build a complete \\\"floor plan\\\" with the [sketcher](Sketcher_Workbench.md), and build one, big, wall object from it. This technique works, but you can only give one thickness for all the walls of the project. Or, you can build each piece of wall from separate line segments.\n\n![](images/At2_Delete.gif )Delete ? *Or, this is what we will do here, a mix of both: We will build a couple of [wires](Draft_Wire.md) on top of the imported plan, one for each type of wall:* Have found that editing a wire is currently more cumbersome than editing a line\n\n![](images/Arch_tutorial_03.jpg )\n\nThe RED lines that will become concrete walls (a [pictures search](http://www.google.com/search?tbm=isch&q=casa+artigas+brooklin) of the house can help you to see the different wall types), the GREEN ones are the exterior brick walls, and the BLUE ones will become the inner walls. Lines are passed through the doors, because doors will be inserted in the walls later, and will create their openings automatically. Walls can also be aligned left, right or centrally on their baseline, so it doesn\\'t matter which side you draw the baseline. Take care on **avoiding intersections** as much as You can. Our model will be cleaner that way. This will save us some headache later, for example if we export our work to other applications, that might not like it.\n\nWhen this is done, place all those lines in a new [group](Std_Group.md) if you want, select each line one by one, and press the [Arch Wall](Arch_Wall.md) tool to build a wall from each of them. You can also select several lines at once. After doing that, and correcting widths (exterior walls are 25cm wide, inner walls are 15cm wide) and some alignments, we have our walls ready:\n\n\"\"\n\nYou should now have a model resembling something like this.\n\n**Grouping**\n\nGrouping of Your various objects can come in handy at a later stage. How to Group Your model is Your choice.\n\nHere is an example:\n\nNote, Baselines for creating walls have also been grouped\n\nWalls have been grouped like:\n\n- Walls\n - WallsExternal\n - WallsInternal\n\n![](images/At2_Tip.png )Tip\n\nHave found the KISS principle (Keep It Simple & Stupid) is a good approach.\n\n- Using lines as a base for walls works fine.\n- They are easy to move and change.\n - When editing the line defining a wall, the wall will update\n- At a later stage You can always join them as needed.\n\n![](images/At2_Tip.png )Tip\n\nSaving Your walls to a new file at this stage can be a good idea.\n\nOne way of doing this is creating a new file.\n\n- Activate Your file containing Walls You have just modelles\n- Mark the groups You want in Your \\'wallModelFile\\'\n- Choose Edit-\\>Copy\n- Activate Your new file\n- Choose Edit-\\>Paste, or Ctrl+v\n- Save Your new file to something meaningful for Your workflow.\n - Suggestion At2_Walls_Initial\n\nWith this work flow:\n\n- Pros\n - You will be able to go back to Your starting point if anything goes wrong\n - You will be building a model consisting of several partial models\n - This is a good way of keeping file size down. You can work on one particual \\'sub model\\' without caring about the overhead of the total model.\n- Cons\n - You will generate a lot of files\n - Be particular how You name Your various files, or get lost.\n\n![](images/At2_Fixme.gif )FIXME\n\nSo, how to organize? Believe the main differing factor is Structural / Non Structural Next Level Inner / Outer\n\n[Curtain Walls](https://en.wikipedia.org/wiki/Curtain_wall_(architecture)) are always Non Structural\n\n#### Joining Wall segments \n\nAll Arch objects have a great feature: you can add one to another. Doing that will unite their geometries, but they are still editable independently after. To add one of our crossing walls to the other, just select one, CTRL + select the other, and press the Arch Add tool:\n\n![](images/Arch_tutorial_05.jpg )\n\nOn the left are the two intersecting walls, on the right the result after adding one to the other.\n\n\n{{Note|An important note about parametric objects|Something is important to consider already. As you can see, in FreeCAD, everything is parametric: Our new \"united\" wall is made from two walls, each based on a baseline. When you expand them in the [tree view](Document_structure.md), you can see all that chain of dependencies. As you can imagine, this little game can quickly become very complex. Furthermore, if you already know how to work with the [sketcher](Sketcher_Workbench.md), you might have wanted to draw the baselines with constrained sketches. This whole complexity has a cost: it raises exponentially the number of calculations that FreeCAD has to perform to keep your model geometry up to date. So, think about it, don't add unnecessary complexity when you don't need it. Keep a good balance between simple and complex objects, and keep these for the cases where you really need them.}}\n\nFor example, I could have drawn all my baselines above without caring about what crosses what, and fix things with the [Arch Add](Arch_Add.md) tool later. But I would have raised much the complexity of my model, for no gain at all. Better make them correct right from the start, and keeping them as very simple pieces of geometry.\n\nNow that our walls are okay, we need to raise their height, until they intersect the roof. Then, since the wall object still cannot be cut automatically by roofs (this will happen some day, though), we will build a \\\"dummy\\\" object, that follows the shape of the roof, to be subtracted from our walls.\n\nFirst, by looking at our 2D drawings, we can see that the highest point of the roof is 5.6m above the ground. So let\\'s give all our walls a height of 6m, so we make sure they will be cut by our dummy roof volume. Why 6m and not 5.6m? You may ask. Well, if you already worked with boolean operations (additions, subtractions, intersections), you must already know that these operations usually don\\'t like much \\\"face-on-face\\\" situations. They prefer clearly, frankly intersecting objects. So by doing this, we keep on the safe side.\n\nTo raise the height of our walls, simply select all of them (don\\'t forget the one we added to the other) in the tree view, and change the value of their \\\"height\\\" property.\n\n#### Studio Elevation \n\nBefore making our roof and cutting the walls, let\\'s make the remaining objects that will need to be cut: The walls of the above studio, and the columns.\n\nWe will now make a [Workplane](Draft_SelectPlane/en.md) and a [workplaneProxy](Draft_WorkingPlaneProxy.md) object at the studio elevation.\n\n\"\"\n\nBefore establishing the elevation, take a look at the base 2d drawings. Something is wrong in paradise.\n\nWe will set top of Studio floor (Slab) to 2425,0 mm\n\nThis can be done in many ways. Probably the easiest is to draw the baseline for studio wall on top of the Plan View, and moving it up 2425mm.\n\n![](images/At2_Delete.gif )Delete ?\n\nThe walls of the studio are made the same way as we did, on the superior floor plan, but they will be raised up to level 2.6m. So we will give them the needed height so their top is at 6m too, that is, 3.4m. Once this is done, let\\'s move our walls up by 2.6m: Select them both, put yourself in frontal view (View → Standard Views → Front), press the [Draft Move](Draft_Move.md) button, select a first point, then enter 0, 2.6, 0 as coordinates, and press enter. Your objects now have jumped 2.6m high:\n\n\n{{Note|About coordinates|The [Draft](Draft_Workbench.md) objects, and most [Arch](Arch_Workbench.md) objects too, obey to a Draft system called [working planes](Draft_SelectPlane.md). This system defines a 2D plane where next operations will take place. If you don't specify any, that working plane adapts itself to the current view. This is why we switched to frontal view, and you see that we indicated a movement in X of 0 and in Y of 2.6. We could also have forced the working plane to stay on the ground, by using the [[Draft SelectPlane]] tool. Then, we would have entered a movement of X of 0, Y of 0 and Z of 2.6. }}\n\n**Alternative Approach**\n\nNow let\\'s move our walls horizontally, to their correct location. Since we have points to snap to, this is easier: Select both walls, press the [Draft Move](Draft_Move.md) tool, and move them from one point to the other:\n\n![](images/Arch_tutorial_07.jpg )\n\nFinally, I changed the color of some walls to a brick-like color (so it\\'s easier to differentiate), and made a small correction: Some walls don\\'t go up to the roof, but stop at a height of 2.60m. I corrected the height of those walls.\n\n### Subtractions\n\nWe will show two different approaches to creating the Subtraction Volume, one drawing on 3d SouthEleveation, second drawing on plan View, rotating and moving.\n\n#### Approach one \n\nIn this Approach we will draw and extrude with correct 3d location\n\n- Set Your WorkingPlane to Front\n- Draw lines following the lower edge of roof\n- Use DraftTrimex to extend and join lines so they form a closed loop\n - Make sure the cutting volume we want to produce extends the bounds of what we want to cut\n- Convert lines to closed dwire\n- Extrude to a dimension larger than total width of elements we want to cut\n- If needed, set workplane to top view, move to top view and move extrusion so it covers the with of the building\n\n\"\" \"\"\n\n#### Approach Two \n\nNow it is time to build our subtraction volume. The easiest way will be to draw its profile on top of the section view. Then, we will rotate it and place it at its correct position. See why I placed the sections and elevations like that before beginning? It will be very handy for drawing stuff there, then moving it to its correct position on the model.\n\nLet\\'s draw a volume, bigger than the roof, that will be subtracted from our walls. To do that, I drew two lines on top of the base of the roof, then extended them a bit further with the [Draft Trimex](Draft_Trimex.md) tool. Then, I drew a [wire](Draft_Wire.md), snapping on these lines, and going well above our 6 meters. I also drew a blue line on the ground level (0.00), that will be our rotation axis.\n\n\"\"\n\nNow is the tricky part: We will use the [Draft Rotate](Draft_Rotate.md) tool to rotate our profile 90 degrees up, in the right position to be extruded. To do that, we must first change the [working plane](Draft_SelectPlane.md) to the YZ plane. Once this is done, the rotation will happen in that plane. But if we do like we did a bit earlier, and set our view to side view, it will be hard to see and select our profile, and to know where is the basepoint around which it must rotate, right? Then we must set the working plane manually: Press the [Draft SelectPlane](Draft_SelectPlane.md) button (it is in the \\\"tasks\\\" tab of the tree view), and set it to YZ (which is the \\\"side\\\" plane). Once you set the working plane manually, like that, it won\\'t change depending on your view. You can now rotate your view until you have a good view of all the things you must select. To switch the working plane back to \\\"automatic\\\" mode later, press the [Draft SelectPlane](Draft_SelectPlane.md) button again and set it to \\\"None\\\".\n\nNow the rotation will be easy to do: Select the profile, press the [Draft Rotate](Draft_Rotate.md) button, click on a point of the blue line, enter 0 as start angle, and 90 as rotation:\n\n\"\"\n\nNow all we need to do it to move the profile a bit closer to the model (set the working plane to XY if needed), and extrude it. This can be done either with the [Part Extrude](Part_Extrude.md) tool, or [Draft Trimex](Draft_Trimex.md), which also has the special hidden power to extrude faces. Make sure your extrusion is larger than all the walls it will be subtracted from, to avoid face-on-face situations:\n\n\"\"\n\n#### Common to both approaches \n\nNow, here comes into action the contrary of the [Arch Add](Arch_Add.md) tool: [Arch Remove](Arch_Remove.md). As you might have guessed, it also makes an object a child of another, but its shape is subtracted from the host object, instead of being united. So now things are simple: Select the volume to subtract (I renamed it as \\\"Roof volume to subtract\\\" in the tree view so it is easy to spot), CTRL + select a wall, and press the [Arch Remove](Arch_Remove.md) button. You\\'ll see that, after the subtraction happened, the volume to subtract disappeared from both the 3D view and the tree view. That is because it has been marked as child of the wall, and \\\"swallowed\\\" by that wall. Select the wall, expand it in the tree view, there is our volume.\n\nNow, select the volume in the tree vieew, CTRL + select the next wall, press [Arch Remove](Arch_Remove.md). Repeat for the next walls until you have everything properly cut:\n\n\"\"\n\nRemember that for both [Arch Add](Arch_Add.md) and [Arch Remove](Arch_Remove.md), the order you select the objects is important. The host is always the last one, like in \\\"Remove X from Y\\\" or \\\"Add X to Y\\\"\n\n\n{{Note|A note about additions and subtractions|Arch objects that support such additions and subtractions (all of them except the \"visual\" helper objects such as the axes) keep track of such objects by having two properties, respectively \"Additions\" and \"Subtractions\", that contain a list of links to other objects to be subtracted or added. A same object can be in the lists of several other objects, as it is the case of our subtraction volume here. Each of the fathers will want to swallow it in the tree view, though, so it will usually \"live\" in the last one. But you can always edit those lists for any object, by double-clicking it in the tree view, which in FreeCAD enters edit mode. Pressing the escape key exits edit mode.}}\n\n![](images/At2_Tip.png )Tip\n\nWork flow note:\n\nIt is probably a good Idea to store Your RoofCutVolume in a separate file for later\n\n### Bathroom Geometry \n\n![](images/At2_Fixme.gif )FIXME\n\n![](images/At2_BathroomGeometry.png )\n\nLooking at bathroom geometry, something is not clear.\n\n### Floors\n\nGenerally defined as Slabs\n\n![](images/Empty_group.png )\n\nTo start with, Create a [group](Std_Group.md) for Floors\n\n![](images/At2_Tip.png )Tip\n\n- Groups are created by **Right + Click** -\\> **Create Group**\n- Groups are created at the position of Your Cursor, meaning You may also create a [group](Std_Group.md) as a subgroup.\n- You may also move a goup to another group by Drag & Drop\n- Groups are Renamed by hitting **F2**, or right click a group and select **Rename**, or **Double Click**\n\n![](images/At2_SetGroup.png )![](images/At2_Group02.png )\n\nBy setting our Group to FloorSlabs, we insure that what we create from now on will be located in this group. (if You forget this step, You can always Drag&Drop entities to this group later)\n\n### Modeling FloorSlabs \n\nIn practice the inner walls (non structural) will probably be placed above the FloorSlabs. For tutorial purposes, we will assume that all walls and columns penetrate the FloorSlabs\n\n![](images/At2_FloorSnap01.png )\n\nNext set the desired [snap settings](Draft_Snap.md). Especially for new users, conflicting snap settings are a cause of frustration.\n\nIn image above, we have the following snap settings active:\n\n- Lock\n- EndPoint\n- Perpendicular\n- Intersection\n- WorkingPlane\n\nAlso make sure WorkingPlane is set to Top.\n\nNow, draw a closed loop to make FloorSlab. This can be done either with lines, or with Draft Dwire. This is Your choice.\n\nRemember that single lines are easier to edit than a dWire, so in many cases it is more efficient to draw single lines, edit, join and add to them, before Joining them to create a dwire.\n\n![ 800px](images/At2_FloorSlab01.png )\n\nYou Should now have something Like image above. **Observe** we have changed the Label to FloorSlab, and ifcRole to Slab (We don\\'t want our floor to be exported as a Column)\n\n#### Cutting FloorSlabs \n\n![](images/At2_Fixme.gif )FIXME Yorik, can You please confirm best practice. Cloning walls to be used for cutting objects does not work. Need to copy cutting objects before ** '''Remove'''**?\n\nIn order to Cut FloorSlab with Our walls, without walls disappearing, we need to first make a Copy of them.\n\nSelect the walls You want to cut the FloorSlab with , and Copy/Paste them.\n\n![ 800px](images/At2_FloorSlabCut03.png )\n\nWe can see that Copied walls have been created in the FloorSlab Group\n\n![ 800px](images/At2_FloorSlabCut04.png )\n\nNow select the cutting objects, and the object to be cut (Parent) as the last one, and Press the ** '''Remove'''** button\n\n![ 800px](images/At2_FloorSlabCut05.png ) Your result should now look something like this. Observe the cutting objects have been \\'swallowed\\' by the FloorSlab object.\n\nNext we need to do the same with the Columns. But first we have to model them.\n\n### Columns\n\nIf you have started with making the Arch Grid, tis is a piece of cake. All columns are at intersections of grid lines.\n\nWhen measuring the columns, we find they are ø300mm. Probably they could be thinner, but we will stick with original design here.\n\n\"\n\nProbably the easiest is to use a circle with R=150 as base for columns. then extrude to 6000mm.\n\nAdjust the height of Columns under Studio Slab.\n\nWe have Labeled the Columns according to the grid-lines the are placed on.\n\nNext Cut the columns going up to the roof, using the same procedure and cutting object as You used whe cutting the walls previously.\n\n### Making the roofs \n\nStarting With outer Beams\n\n\"\"\n\nLooking at the section of the Outer Beams, we can see it is aligned with outer wall. At least in some countries with rougher weather conditions this would be bad practice. Will increase width to 200mm, and have the beam extend 50mm outside the wall.\n\n\"\"Would also like to have what we sometimes call a drip nose. Feel it is a bit complicated to add at the moment.\n\nShowing Section of Beam with DripNose\n\n\"\"\n\nCreated as separate extrudes, added to BuildingPart\n\n![](images/At2_Fixme.gif )FIXME\n\nStruggling with determining best way to model..\n\nTried using Part Boolean Cut For the roof canopy\\...\n\nThe cut results in error when exporting\n\n#### Roof Center Slab \n\nOpen at2_ReferenceComplete ([can be downloaded from here](https://github.com/FreeCAD/Examples/blob/master/at2_Examples/ref/2dReferenceComplete.fcstd))\n\n![](images/AT2_RoofCenterSlab.svg.png )\n\nChoose Edit-\\>Copy (Ctrl+C)\n\nMake a new file\n\nChoose Edit-\\>Paste (Ctrl+V)\n\nMake Your workplane perpendicular to the shapes. This can be done in many ways.\n\n![](images/At2_Fixme.gif )FIXME Comment Add list and ill. of various ways.\n\n![](images/At2_Tip.png )Tip If You made the slab by extrude from Front Plane, it will need to be moved by the global Y-axis. If You move the extrusion, by means of Draft-\\>Move, this will lead to wrongly placed geometry when exporting to IFC. For IFC export to work correct, You need to also move the underlying or defining geometry.\n\n![](images/At2_Fixme.gif )FIXME Comment Add Illustration + Arch Move\n\nLook at [Arch Component](Arch_Component.md)\n\nSome posts relating to issue and resolution\n\n- [Tracker 2014-11-08 14:51 Issue identified](https://freecadweb.org/tracker/view.php?id=1820)\n- [Remove component from draft or sketch](https://forum.freecadweb.org/viewtopic.php?f=23&t=8349)\n\n#### Mods to roof \n\n**Correct supporting wall**\n\n\"\"\n\nIf You cut the wall (RED in image above), we now discover that this is supporting The Roof Center Slab.\n\nThis gives us a great opportunity test editing this wall with \\[\\| Arch remove command\\] ![](images/At2_Fixme.gif )***FIXME Think the doc needs some updating***\n\n![ 800px](images/At2_RoofEast03.jpg )\n\nIn order to add some flexibility beneath Roof slabs, we have made them as image above.\n\nThis means modifying cuts to inner walls and adding a suspended ceiling.\n\nWe will also need to add some covering to the Roof Slabs\n\n![](images/At2_RoofCenter03.jpg )\n\n01\n\n- Shorten supporting wall (Red in above image)\n - First remove \\'cut\\'\n - Adjust height of wall\n - Center The slab on supporting wall\n\n02\n\n- Adjust and construct link between Inner wall and roof of Dormer\n - The inner wall (Green) needs to be combined with the Roof of the Dormer\n\n![ 800px](images/At2_RoofCenter04.png )\n\nThe two highlighted inner walls should probably extend to form the side walls of Dormer\n\n![](images/At2_Tip.png )Tip Add Remove\n\n![ 800px](images/At2_TippRemove01.png )\n\n\n**Right + Click**\n\n, Go to Selection \\--\\> **DblClick** Gets You to Component Structure / Edit\n\n- ![](images/At2_Fixme.gif )FIXME Yorik, is this Correct naming ?\n\n#### Adding Roof slabs \n\nIt is tempting to the roof slabs by grabbing geometry from section A-A. Set working plane to front. ![](images/At2_Fixme.gif )FIXME needs image Draw geometry from section A-A.\n\n- If You use lines, join them to make a wire.\n- If You draw them as a dwire for extrusion.\n - You will need to add a plane to be able to extrude in correct normal direction.\n - Or, You can drop the dwire to a wire, the downside of this is it is not as easy to edit as a dwire.\n\nI am wondering why we have the two different entity types, wire and dwire.\n\n- dwire entity is easily editable at vertex level, wire entity is not\n- ![](images/At2_Tip.png )It would be tempting to extrude symmetric elements like these slabs, with a symmetrical extrusion. This works fine in Freecad, but sadly this does not seem to export correctly if exporting to IFC\n\n#### Adding Dormer \n\n### WokFeature Approach \n\nMake a plane for the two half of the Roof using\n\nTry to use [Work features](Macro_WorkFeatures.md), installed as WorkBench\n\n\"\"\n\nAlso try [Macro_Align_View_to_Face](Macro_Align_View_to_Face.md)\n\n[For Myself\\....](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=10838)\n\nStarted Playing with this.. First interesting feature.. If You select An Arch Axis -\\> place point at extreme, it will place points at all ends of all the selected axis\n\n\"\"\n\nView image, by selecting the X-Axis System and hitting WorkFeature-\\>Create Points at Line Extreme. Thew workFreature macro will create workpoints at end of all defined lines in ArchAxis. In this case AxesX\n\nAlso:\n\n- Planes created with WorkFeature are able to set workplane in draft. (Only tested 0.18)\n- Planes created this way can be named as all other FC features\n- Macro also contains Align View to Workplane feature\n\n#### IFC note \n\nWhen Building part is exported to IFC, it creates 4xIFCproxyElements, and a parent Beam object\n\n![](images/At2_Fixme.gif )FIXME needs updating Check if Fixed\n\n### Stairs\n\nModeling the Stairs may be done in several ways.\n\nHere we will model them the traditional way, but feel free to experiment with the Automated functionality presented in [Arch Stairs](https://forum.freecadweb.org/viewtopic.php?t=29358)\n\n### Doors\n\nInner or outer\n\n### Windows\n\nInner or Outer\n\n## IFC and BIM \n\n[Building Information Modelling (BIM)](https://en.wikipedia.org/wiki/Building_information_modeling) is a very broad term that describes the process of creating a digital model of a building.\n\n### Planning \n\nBEP ( BIM Execution Plan)\n\nAll BIM projects should have a BEP ( BIM Execution Plan)\n\nAs a minimum\n\n#### Common Origin \n\n**Origin point, northing, and elevation**\n\nOne of the simplest yet most critical aspects of good project coordination is the establishment of a common or shared base point for all BIM data to follow. It is also essential to have a common site base point as the data is used through the life-cycle of the building.\n\n### IFC Links \n\n- [IFC - Where it all started - The End of Babel - Part 1/2](https://www.youtube.com/watch?v=g_jmGQvr6dQ)\n- [Planning and Standards by U.S. General Services Administration](https://www.gsa.gov/real-estate/design-construction/3d4d-building-information-modeling/bim-guidelines-for-revit/guidelines/technical-standards/bim-technical-standards-file-structure-and-organization)\n- [IFC4 - is it ready yet?](https://blog.areo.io/ifc4-is-it-ready-yet/)\n- [BimServer Center](https://bimserver.center/)\n- [BIMsie](https://www.nibs.org/page/bsa_bimsie#software)\n- [Sustainability of Digital Formats: Planning for Library of Congress Collections](https://www.loc.gov/preservation/digital/formats/fdd/fdd000447.shtml)\n- [The Top 8 Free and Open Source BIM Software Tools](https://blog.capterra.com/the-top-6-free-bim-software-tools/)\n- [Designing Buildings Wiki](https://www.designingbuildings.co.uk/wiki/Industry_Foundation_Classes_IFC)\n- [BuildingSmart schema after 2x3 TC1](https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/)\n\n### IFC Collaboration \n\n- [Bimsync by Catenda (Norwegian company, dedicated to open standards)](https://home.bimsync.com/)\n- [Open BIMserver](http://bimserver.org/)\n- [Allplan BimPlus (a Nemetschek company)](https://www.allplan.com/products/allplan-bimplus/)\n\n#### Freecad BIM \n\n- [BIM hash on GitHub](https://github.com/OpeningDesign/FreeMVD_WorkFlow/blob/3b0cd9cbd2b7ea33b8ac580d8730478d42b692d6/BIM_Specifications.md)\n\n### IFC round tripping \n\nAim is to also test round tripping, exporting IFC from FreeCAD and importing same file for comparison.\n\n### BIM requirements by stakeholders \n\nIn the [UK](https://www.designingbuildings.co.uk/wiki/UK), the [Government Construction Strategy published in May 2011](https://www.designingbuildings.co.uk/wiki/Government_construction_strategy), stated that the [\\'\\...government](https://www.designingbuildings.co.uk/wiki/Government) will [require fully collaborative 3D BIM](https://www.designingbuildings.co.uk/wiki/Bim) (with all project and [asset](https://www.designingbuildings.co.uk/wiki/Asset) information, documentation and data being electronic) as a minimum by 2016\\'. This represents a minimum requirement for [Level 2 BIM](https://www.designingbuildings.co.uk/wiki/Level_2_bim) on centrally-procured public projects.\n\n## Relevant Forum Posts \n\nHave started gathering some forum post that might be relevant for the TutorialArchBim\n\n- [FreeCAD posts from Yorik\\'s blog](https://forum.freecadweb.org/viewtopic.php?t=17498)\n- [reorder objects](https://forum.freecadweb.org/viewtopic.php?f=3&t=5385&start=20)\n- [Why Switch from FreeCAD to Blender](https://forum.freecadweb.org/viewtopic.php?f=8&t=30371)\n- [Noob. Architecture best practices, workflow and other questions](https://forum.freecadweb.org/viewtopic.php?f=3&t=30132)\n- [BIM Workbench](https://forum.freecadweb.org/viewtopic.php?f=9&t=27237&start=100)\n- [xrefs](https://forum.freecadweb.org/viewtopic.php?f=23&t=20933&start=30)\n- [IFC++](https://forum.freecadweb.org/viewtopic.php?f=23&t=30444&start=10)\n- [controls the color of objects in a IFC?](https://forum.freecadweb.org/viewtopic.php?f=23&t=30670&p=254044#p254044%7CWhat)\n- [An arch project Postby sergiobini Thu Jul 26, 2018 12:18 pm](https://forum.freecadweb.org/viewtopic.php?f=24&t=29959&start=10)\n- [Flameshot: Fantastic Screenshot software for Linux users](https://forum.freecadweb.org/viewtopic.php?f=8&t=30780)\n- [Design for a staircase](https://forum.freecadweb.org/viewtopic.php?t=24168)\n- [BIM / Arch tutorials](https://forum.freecadweb.org/viewtopic.php?f=36&t=30806)\n- [Presenting FreeCad](https://forum.freecadweb.org/viewtopic.php?f=36&t=27169)\n- [Document tree display](https://forum.freecadweb.org/viewtopic.php?f=9&t=30856)\n- [Windows macro, various](https://forum.freecadweb.org/viewtopic.php?style=4&t=25407#p199982)\n- [Reinforcement WB](https://forum.freecadweb.org/viewtopic.php?f=24&t=30617)\n- [Yorik lecture hackable FC](https://archive.fosdem.org/2015/schedule/event/freecad/attachments/slides/667/export/events/attachments/freecad/slides/667/freecad_fosdem15.pdf)\n- [Very interesting presentation of FC and general views on OpenSource in Engineering by Joel Graff](https://forum.freecadweb.org/viewtopic.php?f=36&t=27169&p=263517#p263517)\n\n## General building terminology \n\n- [Roof terminology](https://eurolayasphaltandroofing.co.uk/roofing-terminology/)\n\n## ToDo\n\nThis paragraph or chapter will contain Ideas for improvements, expansion and view, based on communication from participants\n\n## Stubs\n\nThis is where we have temporarily stored snippets of text, that maybe should be placed somewhere in the document\n\nThese texts are all in a ![](images/At2_Fixme.gif )FIXME Comment State\n\n### Snapping Tools \n\n![](images/At2_Fixme.gif )FIXME needs updating\n\n[Noob. Architecture best practices, workflow and other questions](https://forum.freecadweb.org/viewtopic.php?f=3&t=30132) Quoting forum post: {{Code|\nAt first, I didn't understand correctly the snapping tools. The snaps seemed random, but thanks to Regis tutorials on Youtube (cheers mate!!) I started over, using the snaps correctly (almost). This second time, by distraction, I added walls to each other and now I got stuck. I need to subtract a volume because some walls intersect a small slab, and when I do it, nothing happens. At first, they were all disappearing; now, not even that. Now, I know the tutorial recommends that we shouldn't add to much stuff to each other in order to avoid unnecessary complexity, but since it is also a BIM app, shouldn't complexity be part of it? I mean, shouldn't walls, if not adding to one another, at least merge directly to each other, like in Revit for example?\n}}\n\nRemember this was an issue for me to, and probably is for most people trying to learn FreeCAD.\n\nNeeds to be put somewhere in tutorial. Among others, have a look at Regis Snapping\n\nThe [Snap Tools](Draft_Snap.md) are one of Your best friends. However, remember that having all set will in most cases result in an illogical condition. Only leave on the snaps You want.\n\nIf You have struggled with this when learning FreeCAD, take some comfort in that You are not the only one\n\n### Customizing Arch WorkBench \n\nThis is an example \\\"customized\\\" Arch workbench:\n\n![](images/Arch_tutorial_01.jpg )\n\nIn this tutorial, we will model the house in 3D, based on the 2D drawings we will download from the net, and extract from it 2D documents, such as plans, elevations and sections.\n\n### Abbreviations\n\n![](images/At2_Fixme.gif )FIXME Comment\n\nmake list of common abbreviations\n\n[One compilation of Acronyms can be found here](https://www.dummies.com/programming/big-data/your-bim-acronym-guide-what-all-those-letters-mean/)\n\nBEP \\| BIM Execution Plan\n\n### References & Links \n\nReference any input from users or outside sources\n\n### FCStd file \n\n\\[File_Format_FCStd\\| File FormatFCStd\\]\n\n### Command line \n\ncommand line interface\n\nYou can create a log file with the additional commandline parameter\n\nCode: Select all\n\n\\--log-file arg\n\n### Document Draft Snippets \n\n### Customizing Arch WorkBench \n\n[wiki styling](WikiPages.md)\n\n### VDC\n\n![](images/At2_Fixme.gif )FIXME Want to fit VDC in somewhere\n\nVirtual Design and Construction seems to be the next Buzz word after BIM.\n\n[virtual Design and Construction in Skanska Norway](https://www.bi.no/globalassets/forskning/senter-for-byggenaringen/lc-arrangement/lcno-seminar-samlet-170614-pdf.pdf)\n\n## Annex B \n\n### FreeCAD ifcOpenShell \n\n- [Voids](https://forum.freecadweb.org/viewtopic.php?t=25491)\n- [IFC installation](https://forum.freecadweb.org/viewtopic.php?f=4&t=12368)\n- [Add extra python lib path to FreeCAD system path](https://forum.freecadweb.org/viewtopic.php?t=16332)\n\n- [Download IfcOpenShell](http://ifcopenshell.org/python.html)\n\n\n{{Code|\nimport sys\n for p in sys.path:\n print(p)\n}}\n\n#### ifcOpenShell from ppa \n\n\n{{Code|\nsudo add-apt-repository ppa:freecad-community/ppa\nsudo apt-get update\n}}\n\n#### ifcOpenShell python unicode \n\n\n{{Code|\nls -l /usr/lib/python2.7/sitecustomize.py\nlrwxrwxrwx 1 root root 31 sep. 4 07:46 /usr/lib/python2.7/sitecustomize.py -> /etc/python2.7/sitecustomize.py\n}}\n\n#### Build OCE \n\nNo success so far\n\n[GitHub ifcopenshell](https://github.com/IfcOpenShell/IfcOpenShell)\n\n\n{{Code|\nsudo apt-get install git cmake gcc g++ libboost-all-dev libicu-dev\n}}\n\ncompile OCE yourself (note that the build takes a long time):\n\n\n{{Code|\n$ sudo apt-get install libftgl-dev libtbb2 libtbb-dev libgl1-mesa-dev libfreetype6-dev\n$ git clone https://github.com/tpaviot/oce.git\n$ cd oce\n$ mkdir build && cd build\n$ cmake ..\n$ make -j\n$ sudo make install\n}}\n\n### IFC openshell Linux \n\n#### Freecad syspath \n\n\n{{Code|\nimport sys\n>>> for p in sys.path:\n... print(p)\n... \n/usr/lib/freecad-daily/Mod/Drawing\n/usr/lib/freecad-daily/Mod/Inspection\n/usr/lib/freecad-daily/Mod/Idf\n/usr/lib/freecad-daily/Mod/AddonManager\n/usr/lib/freecad-daily/Mod/Robot\n/usr/lib/freecad-daily/Mod/Arch\n/usr/lib/freecad-daily/Mod/Part\n/usr/lib/freecad-daily/Mod/Path\n/usr/lib/freecad-daily/Mod/Mesh\n/usr/lib/freecad-daily/Mod/Raytracing\n/usr/lib/freecad-daily/Mod/Material\n/usr/lib/freecad-daily/Mod/Plot\n/usr/lib/freecad-daily/Mod/Complete\n/usr/lib/freecad-daily/Mod/Tux\n/usr/lib/freecad-daily/Mod/TechDraw\n/usr/lib/freecad-daily/Mod/Import\n/usr/lib/freecad-daily/Mod/Test\n/usr/lib/freecad-daily/Mod/Draft\n/usr/lib/freecad-daily/Mod/Points\n/usr/lib/freecad-daily/Mod/Start\n/usr/lib/freecad-daily/Mod/Spreadsheet\n/usr/lib/freecad-daily/Mod/Fem\n/usr/lib/freecad-daily/Mod/OpenSCAD\n/usr/lib/freecad-daily/Mod/MeshPart\n/usr/lib/freecad-daily/Mod/Web\n/usr/lib/freecad-daily/Mod/Ship\n/usr/lib/freecad-daily/Mod/Measure\n/usr/lib/freecad-daily/Mod/PartDesign\n/usr/lib/freecad-daily/Mod/Surface\n/usr/lib/freecad-daily/Mod/Image\n/usr/lib/freecad-daily/Mod/Show\n/usr/lib/freecad-daily/Mod/ReverseEngineering\n/usr/lib/freecad-daily/Mod/Sketcher\n/usr/lib/freecad-daily/Mod\n/usr/lib/freecad-daily/lib64\n/usr/lib/freecad-daily/lib\n/usr/lib/freecad-daily/Ext\n\n/home/peter\n/usr/lib/python2.7\n/usr/lib/python2.7/plat-x86_64-linux-gnu\n/usr/lib/python2.7/lib-tk\n/usr/lib/python2.7/lib-old\n/usr/lib/python2.7/lib-dynload\n/usr/local/lib/python2.7/dist-packages\n/usr/lib/python2.7/dist-packages\n\n/usr/lib/freecad-daily/Macro\n/usr/lib/freecad/lib\n/home/peter/.FreeCAD/Macro\n/home/peter/.FreeCAD/Macro/WorkFeature/WF_2015.py\n/home/peter/.FreeCAD/Macro/WorkFeature/ParCurve/WF_ObjParCurve_2016.py\n/home/peter/.FreeCAD/Macro/WorkFeature/ParCurve/WF_ObjParCurveEdit_2016.py\n>>> \n}}\n\nadd /usr/lib/python2.7/site-packages\n\n\n{{Code|\nimport sys\nsys.path.append(\"/usr/lib/python2.7/site-packages\")\n}}\n\n![](images/At2_Fixme.gif )FIXME This does not seem to work?\n\n\n{{Code|\npeter@peter-HP-Z400-Workstation:~/.FreeCAD/Macro$ sudo rsync -azv /home/peter/Downloads/ifcopenshell /usr/local/lib/python2.7/site-packages/\n[sudo] password for peter: \nsending incremental file list\nifcopenshell/\nifcopenshell/__init__.py\nifcopenshell/_ifcopenshell_wrapper.so\nifcopenshell/entity_instance.py\nifcopenshell/file.py\nifcopenshell/guid.py\nifcopenshell/ifcopenshell_wrapper.py\nifcopenshell/geom/\nifcopenshell/geom/__init__.py\nifcopenshell/geom/app.py\nifcopenshell/geom/main.py\nifcopenshell/geom/occ_utils.py\n\nsent 19,305,512 bytes received 218 bytes 7,722,292.00 bytes/sec\ntotal size is 49,071,231 speedup is 2.54\n\n}}\n\nEnded up placing ifcopenshell in \\... dist-packages\n\n## Annex B IFC and FreeCAD \n\nThis chapter looks at how FreeCAD entities come across as IFC entities based on using [IfcOpenShell](http://ifcopenshell.org/) as exporter, and following instructions in [Arch](Arch_Workbench.md) and [BIM](BIM_Workbench.md) workbenches\n\nWe start looking at basic objects like Wall and Structure.\n\n### Wall\n\n## Annex D IFC PlusPlus \n\n### Installation\n\nNew try with Ubuntu 18.04 LTS\n\n- [Bernd Hahnebach\\'s](https://forum.freecadweb.org/memberlist.php?mode=viewprofile&u=2069) [Script](https://gist.github.com/berndhahnebach/e4d57634fe7eebbae537bf3da1b1b95a)\n\nDownload **Stretch\\--ifcplusplus.sh** save to Your Home dir.\n\n- Make executeble\n- Open Terminal\n- chmod u+x Stretch\\--ifcplusplus.sh\n- Run the file\n\nError:\n\nSimpleViewerExampled: error while loading shared libraries: libcarved.so: cannot open shared object file: No such file or directory {{Code|\nyorik wrote:\n Thu Aug 30, 2018 6:27 pm\n do you have a libcarved.so together with the SimpleViewerExample executable in Release subfolder? \n}}\n\nTried this script with Ubuntu 16.04 LTS, got all kinds of errors. Mostly Cmake wrong version. See [ifcPlusPlus](https://forum.freecadweb.org/viewtopic.php?f=23&t=30444)\n\n## Annex X \n\nFreecad install directories on [Ubuntu](https://en.wikipedia.org/wiki/Ubuntu_(operating_system)) [Linux](https://en.wikipedia.org/wiki/Linux)\n\nBinary executables\n\n\n{{Code|\n/usr/bin$ ls -l freec*\nlrwxrwxrwx 1 root root 26 aug. 19 21:25 freecad -> ../lib/freecad/bin/FreeCAD\nlrwxrwxrwx 1 root root 29 aug. 19 21:25 freecadcmd -> ../lib/freecad/bin/FreeCADCmd\nlrwxrwxrwx 1 root root 35 aug. 23 04:16 freecadcmd-daily -> ../lib/freecad-daily/bin/FreeCADCmd\nlrwxrwxrwx 1 root root 32 aug. 23 04:16 freecad-daily -> ../lib/freecad-daily/bin/FreeCAD\n-rwxr-xr-x 1 root root 717 aug. 23 01:03 freecad-daily-thumbnailer\n-rwxr-xr-x 1 root root 699 aug. 19 20:29 freecad-thumbnailer\n}}\n\n### Data directories FreeCad \n\n\n{{Code|\n/usr/share$ tree -d ./freecad\n./freecad\n├── examples\n├── Gui\n│ └── Stylesheets\n│ └── images\n└── Mod -> ../../lib/freecad/Mod\n}}\n\nUser Data in {{Code|/Home/User/.FreeCAD}}\n\nseems to be shared with FreeCad-Daily {{Code|\n.FreeCAD\n├── Macro\n├── Macros\n└── Mod\n ├── assembly2\n │ ├── docs\n │ ├── Gui\n │ │ └── Resources\n │ │ ├── icons\n │ │ └── ui\n │ └── tests\n ├── BIM\n │ ├── icons\n │ └── utils\n ├── flamingo\n │ ├── dialogs\n │ ├── examples\n │ ├── icons\n │ ├── shapes\n │ │ ├── ballValves\n │ │ └── butterflyValves\n │ ├── tables\n │ └── tutorials\n ├── FreeCAD_assembly2\n │ ├── docs\n │ ├── Gui\n │ │ └── Resources\n │ │ ├── icons\n │ │ └── ui\n │ └── tests\n └── timber\n └── icons\n\n}}\n\nlink to Mod {{Code|\n/usr/lib$ tree -d ./freecad\n./freecad\n├── bin\n├── Ext\n│ └── freecad\n├── lib\n└── Mod\n ├── AddonManager\n ├── Arch\n │ ├── Dice3DS\n │ ├── Presets\n │ └── Resources\n │ └── icons\n ├── Complete\n │ └── Resources\n │ └── icons\n ├── Draft\n │ └── Resources\n │ └── icons\n ├── Drawing\n │ ├── Resources\n │ │ └── icons\n │ └── Templates\n ├── Fem\n │ ├── femcommands\n │ ├── femguiobjects\n │ ├── feminout\n │ ├── femmesh\n │ ├── femobjects\n │ ├── femresult\n │ ├── femsolver\n │ │ ├── calculix\n │ │ ├── elmer\n │ │ │ └── equations\n │ │ ├── fenics\n │ │ └── z88\n │ ├── femtest\n │ │ └── testfiles\n │ │ ├── ccx\n │ │ ├── elmer\n │ │ └── mesh\n │ ├── femtools\n │ └── Resources\n │ ├── icons\n │ └── ui\n ├── Idf\n │ └── Idflibs\n ├── Image\n │ └── Resources\n │ └── icons\n ├── Import\n ├── Inspection\n │ └── Resources\n │ └── icons\n ├── Material\n │ ├── FluidMaterial\n │ └── StandardMaterial\n │ └── Tools\n ├── Measure\n ├── Mesh\n │ └── Resources\n │ └── icons\n ├── MeshPart\n ├── OpenSCAD\n │ ├── ply\n │ └── Resources\n │ └── icons\n ├── Part\n │ ├── AttachmentEditor\n │ ├── BOPTools\n │ ├── CompoundTools\n │ └── Resources\n │ └── icons\n ├── PartDesign\n │ ├── fcgear\n │ ├── PartDesignTests\n │ ├── Resources\n │ │ └── icons\n │ ├── Scripts\n │ └── WizardShaft\n ├── Path\n │ ├── PathScripts\n │ │ └── post\n │ ├── PathTests\n │ └── Resources\n │ └── icons\n ├── Plot\n │ ├── plotAxes\n │ ├── plotLabels\n │ ├── plotPositions\n │ ├── plotSave\n │ ├── plotSeries\n │ ├── plotUtils\n │ └── resources\n │ └── icons\n ├── Points\n │ └── Resources\n │ └── icons\n ├── Raytracing\n │ ├── Resources\n │ │ └── icons\n │ └── Templates\n ├── ReverseEngineering\n │ └── Resources\n │ └── icons\n ├── Robot\n │ ├── Lib\n │ │ └── Kuka\n │ └── Resources\n │ └── icons\n ├── Ship\n │ ├── resources\n │ │ ├── examples\n │ │ └── icons\n │ ├── shipAreasCurve\n │ ├── shipCapacityCurve\n │ ├── shipCreateLoadCondition\n │ ├── shipCreateShip\n │ ├── shipCreateTank\n │ ├── shipCreateWeight\n │ ├── shipGZ\n │ ├── shipHydrostatics\n │ ├── shipLoadExample\n │ ├── shipOutlineDraw\n │ └── shipUtils\n ├── Show\n ├── Sketcher\n │ ├── ProfileLib\n │ └── Resources\n │ └── icons\n ├── Spreadsheet\n │ └── Resources\n │ └── icons\n ├── Start\n │ ├── Resources\n │ │ └── icons\n │ └── StartPage\n │ └── images\n ├── Surface\n ├── TechDraw\n │ ├── LineGroup\n │ ├── PAT\n │ ├── Patterns\n │ ├── Resources\n │ │ ├── fonts\n │ │ └── icons\n │ ├── TDTest\n │ └── Templates\n ├── Test\n │ └── Resources\n │ └── icons\n ├── Tux\n └── Web\n └── Resources\n └── icons\n\n}}\n\n### Data directories FreeCad-Daily \n\n\n{{Code|\n/usr/share$ tree -d ./freecad-daily\n./freecad-daily\n├── examples\n├── Gui\n│ └── Stylesheets\n│ └── images_dark-light\n└── Mod\n ├── Arch\n │ ├── Presets\n │ └── Resources\n │ └── icons\n ├── Complete\n │ └── Resources\n │ └── icons\n ├── Draft\n │ └── Resources\n │ └── icons\n ├── Drawing\n │ ├── Resources\n │ │ └── icons\n │ └── Templates\n ├── Fem\n │ └── Resources\n │ └── icons\n ├── Image\n │ └── Resources\n │ └── icons\n ├── Import\n │ └── DxfPlate\n ├── Inspection\n │ └── Resources\n │ └── icons\n ├── Material\n │ ├── FluidMaterial\n │ └── StandardMaterial\n │ └── Tools\n ├── Mesh\n │ └── Resources\n │ └── icons\n ├── OpenSCAD\n │ └── Resources\n │ └── icons\n ├── Part\n │ └── Resources\n │ └── icons\n ├── PartDesign\n │ └── Resources\n │ └── icons\n ├── Path\n │ └── Resources\n │ └── icons\n ├── Plot\n │ └── resources\n │ └── icons\n ├── Points\n │ └── Resources\n │ └── icons\n ├── Raytracing\n │ └── Resources\n │ └── icons\n ├── ReverseEngineering\n │ └── Resources\n │ └── icons\n ├── Robot\n │ ├── Lib\n │ │ └── Kuka\n │ └── Resources\n │ └── icons\n ├── Ship\n │ └── resources\n │ └── icons\n ├── Sketcher\n │ └── Resources\n │ └── icons\n ├── Spreadsheet\n │ └── Resources\n │ └── icons\n ├── Start\n │ ├── Resources\n │ │ └── icons\n │ └── StartPage\n ├── TechDraw\n │ ├── LineGroup\n │ ├── PAT\n │ ├── Patterns\n │ ├── Resources\n │ │ ├── fonts\n │ │ └── icons\n │ └── Templates\n ├── Test\n │ └── Resources\n │ └── icons\n └── Web\n └── Resources\n └── icons\n\n}}\n\nAlso in {{Code|\n/usr/lib$ tree -d ./freecad-daily\n./freecad-daily\n├── bin\n├── Ext\n│ └── freecad\n├── lib\n└── Mod\n ├── AddonManager\n ├── Arch\n │ └── Dice3DS\n ├── Complete\n ├── Draft\n ├── Drawing\n ├── Fem\n │ ├── femcommands\n │ ├── femguiobjects\n │ ├── feminout\n │ ├── femmesh\n │ ├── femobjects\n │ ├── femresult\n │ ├── femsolver\n │ │ ├── calculix\n │ │ ├── elmer\n │ │ │ └── equations\n │ │ ├── fenics\n │ │ └── z88\n │ ├── femtest\n │ │ └── testfiles\n │ │ ├── ccx\n │ │ ├── elmer\n │ │ └── mesh\n │ ├── femtools\n │ └── Resources\n │ └── ui\n ├── Idf\n │ └── Idflibs\n ├── Image\n │ └── ImageTools\n ├── Import\n ├── Inspection\n ├── Material\n ├── Measure\n ├── Mesh\n ├── MeshPart\n ├── OpenSCAD\n │ └── ply\n ├── Part\n │ ├── AttachmentEditor\n │ ├── BOPTools\n │ └── CompoundTools\n ├── PartDesign\n │ ├── fcgear\n │ ├── PartDesignTests\n │ ├── Scripts\n │ └── WizardShaft\n ├── Path\n │ ├── Images\n │ │ ├── Ops\n │ │ └── Tools\n │ ├── PathScripts\n │ │ └── post\n │ └── PathTests\n ├── Plot\n │ ├── plotAxes\n │ ├── plotLabels\n │ ├── plotPositions\n │ ├── plotSave\n │ ├── plotSeries\n │ └── plotUtils\n ├── Points\n ├── Raytracing\n ├── ReverseEngineering\n ├── Robot\n ├── Ship\n │ ├── resources\n │ │ └── examples\n │ ├── shipAreasCurve\n │ ├── shipCapacityCurve\n │ ├── shipCreateLoadCondition\n │ ├── shipCreateShip\n │ ├── shipCreateTank\n │ ├── shipCreateWeight\n │ ├── shipGZ\n │ ├── shipHydrostatics\n │ ├── shipLoadExample\n │ ├── shipOutlineDraw\n │ └── shipUtils\n ├── Show\n ├── Sketcher\n │ └── ProfileLib\n ├── Spreadsheet\n ├── Start\n │ └── StartPage\n ├── Surface\n ├── TechDraw\n │ └── TDTest\n ├── Test\n ├── Tux\n └── Web\n\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > Sandbox:TutorialArchBIM\n"} {"id": "freecad-docs:wiki/Scarica.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Scarica.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Scarica.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "1fff90477d2e2225107d76ad5684b83a14f9bd2cba74d83469a0b3d067f3d215", "bytes": 110, "tokens": 49, "text": "# Scarica\n1. REDIRECT [Download/it](Download/it.md)\n\n\n---\n⏵ [documentation index](../README.md) > Scarica\n"} {"id": "freecad-docs:wiki/SheetMetal_Examples.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/SheetMetal_Examples.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/SheetMetal_Examples.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "955147489f2d46a902c7a74836d8706744692ab0655a37cac5eb5821cfe75650", "bytes": 29548, "tokens": 10500, "text": "# SheetMetal Examples\n## Introduction\n\nThe \"\" [SheetMetal workbench](SheetMetal_Workbench.md) (an [external workbench](External_workbenches.md) available through the [Addon Manager](Std_AddonMgr.md)) has grown quite powerful and merits to be appropriately documented.\n\nTo avoid the overcrowding of the tool pages with examples this page was added to collect parts showing and explaining special SheetMetal features.\n\nPlanned phases to generate content:\n\n1. Collecting pictures\n2. Adding workflow descriptions\n3. Adding more detailed tutorials\n\n## Hinge\n\n \"\"\n\"\" \"\" \"\" \"\" \n*Workflow Hinge:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [PartDesign Pocket](PartDesign_Pocket.md)**,\n** [PartDesign Hole](PartDesign_Hole.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n\n
\n\n### Hinge step by step \n\n\n
\n\n1. Create a profile (a line and a tangent arc), preferably using the \"\" [Sketcher Workbench](Sketcher_Workbench.md).\n2. Activate the \"\" [Make Base Wall](SheetMetal_AddBase.md) command to create a BaseBend object.\n3. Edit the BaseBend object\\'s parameters:\n - Set **Mid Plane** to `True`to let the profile extend symmetrically to both sides of the sketch plane.\n - Set **radius** and **thickness** to values of your choice.\n4. Create a cut-out contour with the \"\" [Sketcher Workbench](Sketcher_Workbench.md).\n5. Use the \"\" [PartDesign Pocket](PartDesign_Pocket.md) command to cut off one half of the Round bit.\n6. Create a hole pattern with the \"\" [Sketcher Workbench](Sketcher_Workbench.md).\n7. Use the \"\" [PartDesign Hole](PartDesign_Hole.md) command. Avoid the countersink and counterbore options to keep the body unfoldable.\n8. Activate the \"\" [Unfold](SheetMetal_Unfold.md) command to get an Unfold object.\n9. Done!\n\n\n
\n\n\n
\n\n## Paper clip \n\n \"\"\n\"\" \"\" \"\" \"\" \n*Workflow Paper Clip:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [Sketch on Sheet](SheetMetal_SketchOnSheet.md)**,\nclone, flip and fuse,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n\n
\n\n### Paper clip step by step \n\n\n
\n\n1. Create a profile, preferably using the \"\" [Sketcher Workbench](Sketcher_Workbench.md) on the XZ plane.\n \"Profile\n2. Activate the \"\" [Make Base Wall](SheetMetal_AddBase.md) command to create a BaseBend object.\n3. Edit the BaseBend object\\'s parameters in the properties panel:\n \"BaseBend\n - Set **Mid Plane** to `True`to let the profile extend symmetrically to both sides of the sketch plane.\n - Set **length** to 32 mm.\n - Set **radius** to 2 mm.\n - Set **thickness** to 0.3 mm.\n4. Select the face between the round sections and activate the \"\" [Sketcher Workbench](Sketcher_Workbench.md).\n \"Face\n5. To hide the curled part use the \"\" [Sketcher View section](Sketcher_ViewSection.md) command.\n6. Create the cut-out contour.\n \"Cut-out \"Cut-out\n7. Finish the sketch using the \"\" [Sketcher Leave sketch](Sketcher_LeaveSketch.md) command.\n8. Select the face again and add the Cut-out sketch to the selection.\n \"Face\n9. Use the \"\" [Sketch on Sheet](SheetMetal_SketchOnSheet.md) command to cut around the curled bit.\n \"Finished\n10. One side is finished. We now need to find a way to mirror the body.\n\n**Potential mirror options:**\n\n- The \"\" [PartDesign Mirrored](PartDesign_Mirrored.md) command fails because it cannot handle SheetMetal features for some reason. So that does not work.\n- The \"\" [Part Mirror](Part_Mirror.md) command creates a mirrored part, but this is no longer unfoldable. So that does not work either.\n- One way that can work is to use a clone. This still can\\'t be mirrored, but it can use axial symmetry (turn it 180°).\n- Another way that works is to use a link object.\n\n**Mirror using a clone:**\n\n1. Select the body from the tree view.\n2. Use the \"\" [PartDesign Clone](PartDesign_Clone.md) command. It adds a new body containing a clone object.\n To apply a 180° turn set the **Angle** under the Placement property of either the body or the clone to 180°. (Z axis is default and should be fine if you started on the XZ plane as described).\n \"Cloned \"\" \"Flipped\n3. With the body still active, use the \"\" [PartDesign Boolean operation](PartDesign_Boolean.md) command to add the body of the clone and fuse both halves.\n \"Fused\n4. Activate the \"\" [Unfold](SheetMetal_Unfold.md) command to get an Unfold object.\n \"Clip \"Unfold\n5. Done!\n\n**Mirror using a link object:**\n\n1. Select the body from the tree view.\n2. Use the \"\" [Make link](Std_LinkMake.md) command. This adds a new link object.\n3. Duplicate the link object by setting the property **Element Count** to 2.\n4. To apply a 180° turn set the **Angle** under the Placement property of either of the sub-linked objects to 180°. (Z axis is default and should be fine if you started on the XZ plane as described).\n5. Select both sub-linked objects in the tree view.\n6. Activate the \"\" [Part Fuse](Part_Fuse.md) command to fuse both halves.\n \"Fused\n7. Activate the \"\" [Unfold](SheetMetal_Unfold.md) command to get an Unfold object.\n \"Clip \"Unfold\n8. Done!\n\n\n
\n\n\n
\n\n## Omega clamp \n\n \"\"\n\"\" \"\" \"\" \"\" \n*Workflow Omega Clip:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [PartDesign Hole](PartDesign_Hole.md)**,\n** [PartDesign Fillet](PartDesign_Fillet.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n## Hex bowl \n\n \"\"\n\"\" \"\" \"\" \"\" \n*Workflow Hex Bowl:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [Make Wall](SheetMetal_AddWall.md)**,\n6x ** [Add Corner Relief](SheetMetal_AddCornerRelief.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n\"\"\n\nWhen a Corner Relief is added (right side) it can be necessary to adjust the value of the **Size** property.\n\n## Pen clip \n\n \"\"\n\"\" \"\" \"\" \"\" \"\" \"\" \n*Workflow Pen Clip:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [PartDesign Pocket](PartDesign_Pocket.md)**,\n3x ** [Make Wall](SheetMetal_AddWall.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n## Extend face example \n\n \"\"\n\"\" \"\" \"\" \"\" \"\" \n*Workflow Extend Face Example:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [Make Wall](SheetMetal_AddWall.md)**,\n** [Extend Face](SheetMetal_Extrude.md)**,\n** [Extend Face](SheetMetal_Extrude.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\nFor the second use of **Extend Face** a Sketch with two contours is used for shape of the extension(s); and with the value of \\\"use subtraction\\\" set to true it provides the shape for the cut-outs, as well\n\n## USB shield contact \n\n \"\"\n\"\" \"\" \"\" \"\" \"\" \"\" \n*Workflow USB shield contact:\n** [Make Base Wall](SheetMetal_AddBase.md)*,\n{{Button| [Extend Face](SheetMetal_Extrude.md)**,\n** [PartDesign Pocket](PartDesign_Pocket.md)**,\n** [Extend Face](SheetMetal_Extrude.md)**,\n** [Make Wall](SheetMetal_AddWall.md)**,\n** [Unfold](SheetMetal_Unfold.md)**.\n}}\n\n(The pull relief is just an artistic expression of what could be hidden inside a real plug)\n\n## SheetMetal properties \n\nThis section tries to explain the properties of each SheetMetal object with simple images, where applicable.\n\n\n
\n\n### BaseBend object \"\" \n\n\n
\n\n \"\" \"\" \"\" \n\n\n*Selected sketch + \n** [Make Base Wall](SheetMetal_AddBase.md)* \n→ BaseBend object with default settings**\n\n \"\" \"\" \"\" \n\n\n*Edit **length*: Default length → Reduced length**\n\n \"\" \"\" \"\" \n\n\n*Switch **Mid Plane* from {{False** to `True`: Extrusion in one direction → Symmetric extrusion}}\n\n \"\" \"\" \"\" \n\n\n*Switch **Reverse* from {{False** to `True`: Default direction → Inverted direction}}\n\n \"\" \"\" \"\" \"\" \"\" \n\n\n*Select **Bend Side*: {{value|Outside** (default) → {{value|Inside}} → {{value| Middle}}}}\n\n \"\" \"\" \"\" \n\n\n*Edit **radius*: Default radius → Enlarged radius.
\nThis property is the inner radius of the bends created at the vertices where two edges in the sketch have a non-tangential transition.**\n\n \"\" \"\" \"\" \n\n\n*Edit **thickness*: Default Thickness → Enlarged thickness**\n\n\n
\n\n\n
\n\n\n
\n\n### Bend object \"\" \n\n\n
\n\nA Bend object consists of sets of one cylindrical bend and one planar strip each. Each pair extends from a selected edge of a blank.\n\n \"\" \"\" \"\" \n\n\n*Selected edges + \n** [Make Wall](SheetMetal_AddWall.md)* \n→ Bend objects with default settings
\n(Two Bend objects in two separate bodies.)**\n\nEdit **radius** to vary the inner radius of all bends supplied by a Bend object. (See BaseBend object above)\n\nEdit **length** to vary the length of all planar strips extending from the bends of a Bend object.\n\n: Don\\'t confuse the **length** with a flange length which is the sum of this length, radius, and thickness (90° only).\n\n \"\" \"\" \"\" \n\n\n*Switch **invert* from {{FALSE** to `True`:Default flanges (Bend objects) → Inverted flanges}}\n\n \"\" \"\" \"\" \"\" \"\" \n\n\n*Edit **angle*:Default angle (90°) → Enlarged angle → Decreased angle**\n\nWe don\\'t have to care about trimming the edges, because **Auto Miter** is activated by default.\nIf deactivated, the result would look like this:\n\n \"\" \"\" \"\" \"\" \"\" \n\n\n*Switch **Auto Miter* from {{TRUE** to `False`: Default angle (90°) → Enlarged angle → Decreased angle
\n(Auto Miter has no effect on single flanges)}}\n\nTo manually miter a flange edge **miterangle1** and **miterangle2** are used:\n\n \"\" \"\" \"\" \"\" \"\" \n\n\n*Edit **miterangle1* and {{PropertyData|miterangle2**: No miter (default) → Differently mitered edges, positive angle → Symmetrically mitered edges, negative angles}}\n\nMitering only effects the planar strips, not the bends.\n\n: (It takes the whole edge into account and so cannot be used to chamfer flange edges)\n\nTo display the different choices of **Bend Type** we introduce an auxiliary cuboid that extrudes from the same outline as the blank and has the same height as the Bend object (its flange length).\n\n \"\" \"\" \"\" \"\" \"\" \"\" \"\" \n\n\n*Select **Bend Type*: {{value|Material Outside** (default) → {{value|Material Inside}} → {{value|Thickness Outside}} → {{value|Offset}}}}\n\n- Outside: The bend starts at the selected edge (The whole Bend object lies outside the cuboid).\n- Inside: The outer side of the bend ends on the cuboid surface (The whole Bend object lies inside the cuboid).\n- Thickness Outside: The inner side of the bend ends on the cuboid surface (only the planar strip is protruding from the cuboid surface).\n- Offset: According to the value of **offset** the bend is moved in outward direction from its default position.\n\n: An extension is inserted for positive values (high-lighted strip).\n: Negative values are allowed to move the bend inwards.\n\nIf we don\\'t want to use the whole length of an edge we can use **gap1** and **gap2**.\n\n \"\" \"\" \"\" \n\n\n*Edit **gap1* and {{PropertyData|gap2**: Default flanges → Flanges with different values for gap1 and gap2}}\n\nIf the length of a gap reaches or extends the value of **min Relief Gap**, a relief will be added to the gap.\nReliefs are controlled by **relief Type**, **reliefd** (relief depth), and **reliefw** (relief width) which are enabled only when a gap value is set.\n\n \"\" \"\" \"\" \"\" \"\" \n\n\n*Edit **reliefd* and {{PropertyData|reliefw**: Default values → Relief depth enlarged → Relief depth and width enlarged}}\n\n \"\" \"\" \"\" \n\n\n*Switch **relief Type* from {{value|Rectangle** to {{value|Round}}: Default rectangular relief → Round relief}}\n\nThe round option will only be applied, if the relief depth is larger than the relief width.\n\nSwitch **Use Relief Factor** from `False` (default) to `True` to set the values of **reliefd** and **reliefw** automatically. Both are set to the object\\'s (inherited) thickness multiplied by the value of **Relief Factor**.\n\n: In this case the round option is useless, since the relief depth is as large as the relief width. (See above)\n\nA new property **Length Spec** (v0.21) enables us to choose how to measure the length of the Bend object:\n\n \"\" \n*Side view of four 120° flanges with default length (10 mm) and different **Length Spec* values:
{{value|Leg** (default), {{value|Outer Sharp}}, {{value|Inner Sharp}}, {{value|Tangential}}}}\n\nWith the {{value|Tangential}} option selected the property **length** is the equivalent of the flange length.\n\n\n{{value|Outer Sharp}}\n\nand {{value|Tangential}} are identical for 90° angles.\n\n\n
\n\n\n
\n\n\n
\n\n### Extend object \"\" \n\n\n
\n\nAn Extend object extends a sheet metal plate at one or more selected edge faces or edges.\n\n \"\" \"\" \"\" \n\n\n*Selected edge face and edges + \n** [Extend Face](SheetMetal_Extrude.md)* \n→ One Extend object with default settings.**\n\nA first issue occurs here: Although the property **Refine** is set to `True` two of the extensions still show their seam lines. Only the extension of the last selected element will be refined.\n\nTo refine all extensions they have to be created separately:\n\n \"\" \"\" \"\" \"\" \"\" \"\" \"\" \n\n\n*3x Selected edge face or edge + \n** [Extend Face](SheetMetal_Extrude.md)* \n→ Three Extend objects completely refined and with default settings.**\n\nAltered properties apply to all edges listed in the related **base Object** of the Extension object.\n\nEdit **length** to adjust the length of the extension.\n\n \"\" \"\" \n\n\n*Edit **gap1* and {{PropertyData|gap2** to reduce the width of the extension.
\nLeft: Extension object with 3 edges. Right: One of the Extension objects with one single edge.}}\n\nLink a sketch to the property **Sketch** to shape an extension. The properties **length**, **gap1** and **gap2** will be ignored once a sketch is linked. (This seems not to work with still unbent blanks).\n\n \"\" \"\" \"\" \n\n\n*A selected sketch lying on the flange to be extended → Resulting extension*\n\nIt is plain to see that it doesn\\'t matter which edge was selected for the Extend object, the shape of the flange is changed wherever sketch geometry protrudes, the new shape can even contain parts that are disconnected from the original flange. Multiple outlines are no problem, but the flange is not cut into.\n\nThis example shows that designers are responsible for their construction and shouldn\\'t rely on the results of their tools, which do not make sense in this case. The Sketch attached to a flange face is problematic as well due to the toponaming problem, but for this a solution is in sight.\n\nBut there are better use cases for this tool involving almost closed shapes such as one of the examples on the [SheetMetal Extrude](SheetMetal_Extrude.md) page:\n\n \"\" \"\" \"\" \n\n\n*An almost closed profile → The added default extension is fused with the opposite side creating a closed profile (a tube) that is not unfoldable*\n\n \"\" \"\" \"\" \n\n\n*Link a rectangular sketch to the property **Sketch*: Closed profile → Profile with rectangular extension, still fused**\n\n \"\" \"\" \"\" \n\n\n*Switch **Use Subtraction* to {{true** to provide a (hardly visible) default gap between the Extension object and the opposite side, then increase **Offset** to widen the gap:
\nFused profile → Profile with interlocking extension, this final result is unfoldable}}\n\n\n
\n\n\n
\n\n\n
\n\n### Fold object \"\" \n\n\n
\n\nA Fold object is the result of a sheet metal plate bent at a given line.\n\nChange the property **Position** to control where the bend is positioned according to the bend line.\n\n \"\" \n\n\n*Cross-section of the bend: The bend line lies on the upper face of the blank (black) with a 10 mm offset from the edge, its position is maked with a pentagon. It also defines the virtual intersection of the blank and the bent wall*\n\n\n
\n\n\n
\n\n\n---\n⏵ [documentation index](../README.md) > [SheetMetal](Category_SheetMetal.md) > [Addons](Category_Addons.md) > [External Command Reference](Category_External%20Command%20Reference.md) > SheetMetal Examples\n"} {"id": "freecad-docs:wiki/SheetMetal_Extrude.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/SheetMetal_Extrude.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/SheetMetal_Extrude.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7322751c5c4d1073b418b5cfa52e429cd9f5d90eb6e9cde32534da603da33ddc", "bytes": 6071, "tokens": 1945, "text": "---\n GuiCommand:\n Name: SheetMetal Extrude\n MenuLocation: SheetMetal , Extend Face\n Workbenches: SheetMetal_Workbench\n Shortcut: **E**\n---\n\n# SheetMetal Extrude\n\n## Description\n\nThe \"\" **SheetMetal Extrude** command extends a sheet metal plate at a selected edge face.\n\nIt creates a **simple extension** along the face normal of the selected edge face:\n\n \"\" \"\" \"\" \n\nIf an outline sketch is added it creates **interlocking geometry** to close a profile:\n\n \"\" \"\" \"\" \n\n\n*Three profiles with outline sketches to add → three results*\n\n## Usage\n\n### Simple Extension \n\n1. Select one or more edge face(s) to be extended.\n2. There are several ways to invoke the command:\n - Press the ** [Extend Face](SheetMetal_Extrude.md)** button.\n - Select the **Sheet Metal → Extend Face** option from the menu.\n - Right-click in the [Tree view](Tree_view.md) or the [3D view](3D_view.md) and select the **Sheet Metal → Extend Face** option from the context menu.\n - Use the keyboard shortcut: **E**.\n3. The **Extend Parameters** [Task panel](Task_panel.md) opens (introduced in version 0.5.00).\n4. Optionally press the **Select** button to add more faces.\n - Press the **Preview** button to finish the selection and display the changes.\n5. Optionally adjust the parameters in the Task panel.\n6. Press the **OK** button to finish the command and close the Task panel.\n7. An **Extend** object will be created consisting of one new face extension at each selected face.\n8. Optionally adjust the parameters in the [Property editor](Property_editor.md).\n\n### Interlocking Extension \n\n: (Prepare a \"\" [sketch](Sketcher_Workbench.md) for interlocking tabs)\n\n1. Select the edge face to be extended.\n2. Invoke the command as described above.\n3. Press the **OK** button to finish the command and close the Task panel.\n4. In the [Property editor](Property_editor.md) press the **...** button of the **Sketch** property.\n5. The Link dialog window opens.\n - Select the prepared sketch from the list\n - Press the **OK** button to close the dialog.\n6. Set the property **Use Subtraction** to `True` to create cut-outs to make room for the extensions.\n7. Set the property **Offset** to adjust the clearance around the extension.\n\n \"\" \"\" \"\" \"\" \"\" \"\" \"\" \n\n\n*Three profiles → position of the sketches → results without cut-outs → final results*\n\n### Notes\n\n- A sketch can contain more than one outline.\n\n: After inserting a sketch, at least one of its outlines must at least touch one opposite face or the tool will fail to create any extension or cut-out.\n\n\n: Just one outline touching an opposite face is enough to create extension geometry from all outlines of the sketch.\n\n- Each cut-out will have a cuboid shape, no matter what shape the corresponding outline sketch is.\n\n- Shapes other than rectangles may behave little bit strange and even though the object can be unfolded, the result will not turn out as expected.\n\n \"\" \"\" \"\" \n\n\n*Three outline sketches and their resulting extensions: separate triangle plate with a rectangular cut-out, circle without clearance → unfold solid is split at an unexpected position *\n\n- In an extension operation it is recommended to leave the property **Refine** set to `True` (default).\n\n- The extension operation with a linked sketch may fail due to coplanar issues if the face on the sketch side and the face on the opposite side are coplanar, but with opposite orientations. A small offset may help in such a case.\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nA SheetMetal Extend object is derived from a [Part Feature](Part_Feature.md) object or, if it is inside a [PartDesign Body](PartDesign_Body.md), from a [PartDesign Feature](PartDesign_Feature.md) object, and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{Properties_Title|Parameters}}\n\n- **base Object|LinkSub**: \\\"Base object\\\". Link to the planar face to be extended.\n\n- **gap1|Distance**: \\\"Gap from the left side\\\". Default: {{value|0,00 mm}}.\n\n- **gap2|Distance**: \\\"Gap from the right side\\\". Default: {{value|0,00 mm}}.\n\n- **length|Length**: \\\"Length of Wall\\\". Default: {{value|10,00 mm}}.\n\n\n{{Properties_Title|Parameters Ext.}}\n\n- **Offset|Distance**: \\\"Offset for subtraction\\\". Default: {{value|20,00 µm}}.\n\n- **Refine|Bool**: \\\"Use Refine\\\". Default: `True`.\n\n- **Sketch|Link**: \\\"Wall Sketch\\\".\n\n- **Use Subtraction|Bool**: \\\"Use Subtraction\\\". Default: `False`\n\n\n---\n⏵ [documentation index](../README.md) > [SheetMetal](Category_SheetMetal.md) > [Addons](Category_Addons.md) > [External Command Reference](Category_External%20Command%20Reference.md) > SheetMetal Extrude\n"} {"id": "freecad-docs:wiki/Ship_TankNew.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Ship_TankNew.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Ship_TankNew.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "4e60d2f6de45e86f560034ce179507f4b2e77d32f006e08bda42c87b9f37cf54", "bytes": 116, "tokens": 55, "text": "# Ship TankNew\n1. REDIRECT [Ship_Tank](Ship_Tank.md)\n\n\n---\n⏵ [documentation index](../README.md) > Ship TankNew\n"} {"id": "freecad-docs:wiki/Sketcher_CompCreateBSpline.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_CompCreateBSpline.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_CompCreateBSpline.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "572d190f319866f00697d2cb1c72b6b7c074b2bce34e02dc62e127aec0ca71ca", "bytes": 252, "tokens": 101, "text": "# Sketcher CompCreateBSpline\n1. REDIRECT [Sketcher_Workbench#Sketcher_CompCreateBSpline](Sketcher_Workbench#Sketcher_CompCreateBSpline.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher CompCreateBSpline\n"} {"id": "freecad-docs:wiki/Sketcher_CompCreateCircle.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_CompCreateCircle.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_CompCreateCircle.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a08b0a7fff92e2db00b2deefb55244dc92574af0caa5a5b86e3ef127c62a1d6f", "bytes": 246, "tokens": 99, "text": "# Sketcher CompCreateCircle\n1. REDIRECT [Sketcher_Workbench#Sketcher_CompCreateConic](Sketcher_Workbench#Sketcher_CompCreateConic.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher CompCreateCircle\n"} {"id": "freecad-docs:wiki/Sketcher_ConstrainHorVer.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_ConstrainHorVer.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_ConstrainHorVer.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "d2ca2bac23266e7e4114a0ed24d5c4e337cd89db9c373e33c9f4e9c10bad68e1", "bytes": 2970, "tokens": 947, "text": "---\n GuiCommand:\n Name: Sketcher ConstrainHorVer\n MenuLocation: Sketch , Sketcher constraints , Constrain horizontal/vertical\n Workbenches: Sketcher_Workbench\n Shortcut: **A**\n Version: 1.0\n SeeAlso: Sketcher_ConstrainHorizontal, Sketcher_ConstrainVertical\n---\n\n# Sketcher ConstrainHorVer\n\n## Description\n\nThe \"\" [Sketcher ConstrainHorVer](Sketcher_ConstrainHorVer.md) tool constrains lines or pairs of points to be horizontal (parallel to the horizontal axis of the sketch) or vertical, whichever is closest to the current alignment.\n\nThis tool combines the [Sketcher ConstrainHorizontal](Sketcher_ConstrainHorizontal.md) and [Sketcher ConstrainVertical](Sketcher_ConstrainVertical.md) tools.\n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n### [Continue mode](Sketcher_Workbench#Continue_modes.md) \n\n1. Make sure there is no selection.\n2. There are several ways to invoke the tool:\n - If the **Auto tool for Horizontal/Vertical** [preference](Sketcher_Preferences#General.md) is selected (default): press the ** [Constrain horizontal/vertical](Sketcher_ConstrainHorVer.md)** button.\n - Select the **Sketch → Sketcher constraints → Constrain horizontal/vertical** option from the menu.\n - Right-click in the [3D view](3D_view.md) and select the **Constrain → Constrain horizontal/vertical** option from the context menu.\n - Use the keyboard shortcut: **A**.\n3. The cursor changes to a cross with the tool icon.\n4. Do one of the following:\n - Select two points.\n - Select a single line.\n5. A constraint is added.\n6. Optionally keep creating constraints.\n7. To finish, right-click or press **Esc**, or start another geometry or constraint creation tool.\n\n### Run-once mode \n\n1. Do one of the following:\n - Select two or more points (the selection order can be relevant see [Notes](#Notes.md)).\n - Select one or more lines. Points can be included in the selection, but will be ignored.\n2. Invoke the tool as explained above, or with the following additional option:\n - Right-click in the [3D view](3D_view.md) and select the ** Constrain horizontal/vertical** option from the context menu.\n3. Depending on the selection one or more constraints are added.\n\n## Notes\n\n- More than 2 points are processed in the selection order, one pair at a time. The 1st point is paired with the 2nd. When they are constrained the 2nd point may move. The new location of the 2nd point determines which constraint is applied when the 2nd and 3rd point are constrained, etc.\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher ConstrainHorVer\n"} {"id": "freecad-docs:wiki/Sketcher_ConstrainLock.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_ConstrainLock.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_ConstrainLock.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "87bfd502211f58b468a438732720a091c0c35a584ba8b655a0bea43b3a794aca", "bytes": 2716, "tokens": 885, "text": "---\n GuiCommand:\n Name: Sketcher ConstrainLock\n MenuLocation: Sketch , Sketcher constraints , Constrain lock\n Workbenches: Sketcher_Workbench\n Shortcut: **K** **L**\n SeeAlso: Sketcher_ConstrainBlock\n---\n\n# Sketcher ConstrainLock\n\n## Description\n\nThe \"\" [Sketcher ConstrainLock](Sketcher_ConstrainLock.md) tool applies [Horizontal distance](Sketcher_ConstrainDistanceX.md) and [Vertical distance](Sketcher_ConstrainDistanceY.md) constraints to points. If a single point is selected the constraints reference the origin of the sketch. If two or more points are selected the constraints reference the last point in the selection.\n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n### [Continue mode](Sketcher_Workbench#Continue_modes.md) \n\n1. Make sure there is no selection.\n2. There are several ways to invoke the tool:\n - \n (v1.0) \n \n : If the **Dimensioning constraints** [preference](Sketcher_Preferences#General.md) is set to {{Value|Single tool}} (default): press the down arrow to the right of the **** button and select the ** Constrain lock** option from the dropdown.\n\n - If this preference has a different value (and in {{VersionMinus|0.21}}): press the ** [Constrain lock](Sketcher_ConstrainLock.md)** button.\n\n - Select the **Sketch → Sketcher constraints → Constrain lock** option from the menu.\n\n - \n (v1.0) \n \n : Right-click in the [3D view](3D_view.md) and select the **Dimension → Constrain lock** option from the context menu.\n\n - Use the keyboard shortcut: **K** then **L**.\n3. The cursor changes to a cross with the tool icon.\n4. Select a single point.\n5. Two constraints are added.\n6. Optionally keep creating constraints.\n7. To finish, right-click or press **Esc**, or start another geometry or constraint creation tool.\n\n### Run-once mode \n\n1. Select one or more points.\n2. Invoke the tool as explained above.\n3. Depending on the selection two or more constraints are added.\n\n## Notes\n\n- There is no automatic prompt to edit the constraint values. If required values can be [edited manually](Sketcher_Workbench#Edit_constraints.md).\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher ConstrainLock\n"} {"id": "freecad-docs:wiki/Sketcher_ConstrainPerpendicular.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_ConstrainPerpendicular.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_ConstrainPerpendicular.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "352c67c5044f36ae594911196505e719b0b1538d1668bb0ac32fbd25a7a527c4", "bytes": 6030, "tokens": 1810, "text": "---\n GuiCommand:\n Name: Sketcher ConstrainPerpendicular\n MenuLocation: Sketch , Sketcher constraints , Constrain perpendicular\n Workbenches: Sketcher_Workbench\n Shortcut: **N**\n SeeAlso: Sketcher_ConstrainAngle\n---\n\n# Sketcher ConstrainPerpendicular\n\n## Description\n\nThe \"\" [Sketcher ConstrainPerpendicular](Sketcher_ConstrainPerpendicular.md) tool constrains two lines to be perpendicular, or two edges, or an edge and an axis, to be perpendicular at their intersection. Lines are treated as infinite, and open curves are virtually extended as well. The constraint can also connect two edges, forcing them to be perpendicular at the joint.\n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n### [Continue mode](Sketcher_Workbench#Continue_modes.md) \n\n1. Make sure there is no selection.\n2. There are several ways to invoke the tool:\n - Press the ** [Constrain perpendicular](Sketcher_ConstrainPerpendicular.md)** button.\n\n - Select the **Sketch → Sketcher constraints → Constrain perpendicular** option from the menu.\n\n - \n (v1.0) \n \n : Right-click in the [3D view](3D_view.md) and select the **Constrain → Constrain perpendicular** option from the context menu.\n\n - Use the keyboard shortcut: **N**.\n3. The cursor changes to a cross with the tool icon.\n4. Do one of the following:\n - Select two edges. One of the edges must be a straight line or an axis. The other can be any edge except a B-spline.\n - Select a point and two edges (in that order).\n - Select an edge, a point and another edge (idem).\n5. A Perpendicular constraint is added. If a point and two edges have been selected, up to two [Point on object constraints](Sketcher_ConstrainPointOnObject.md) can also be added. See [Examples](#Between_two_edges_at_point.md).\n6. Optionally keep creating constraints.\n7. To finish, right-click or press **Esc**, or start another geometry or constraint creation tool.\n\n### Run-once mode \n\n1. Do one of the following:\n - Select two edges (see above).\n - Select two endpoints belonging to different edges.\n - Select an edge and the endpoint of another edge (in any order).\n - Select a point and two edges (idem).\n2. Invoke the tool as explained above, or with the following additional option:\n - \n (v1.0) \n \n : Right-click in the [3D view](3D_view.md) and select the ** Constrain perpendicular** option from the context menu.\n3. A Perpendicular constraint is added. If a point and two edges have been selected, up to two [Point on object constraints](Sketcher_ConstrainPointOnObject.md) can also be added. See [Examples](#Between_two_edges_at_point.md).\n\n## Examples\n\n### Between two edges \n\n \"\" \n\nThe two edges are made perpendicular at their (virtual) intersection. If one of the edges is a [conic](Sketcher_Workbench#Sketcher_CompCreateConic.md), a [Point object](Sketcher_CreatePoint.md) that has a [Point on object constraint](Sketcher_ConstrainPointOnObject.md) with both (extended) edges is added.\n\n### Between two endpoints \n\n \"\" \n\nThe endpoints are made coincident, and the edges are made perpendicular at that point.\n\n### Between edge and endpoint \n\n \"\" \n\nThe endpoint of one edge is constrained to lie on the other edge, and the edges are made perpendicular at that point.\n\n### Between two edges at point \n\n \"\" \n\nThe two edges are made perpendicular at a given point. The point can be any point, e.g. the center of a circle, the endpoint of an edge, or the origin, it can belong to one of the edges, and it can also be a [Point object](Sketcher_CreatePoint.md). If required [Point on object constraint(s)](Sketcher_ConstrainPointOnObject.md) are added to ensure the point lies on both (extended) edges. These additional constraints are called [helper constraints](Sketcher_helper_constraint.md).\n\n## Scripting\n\nPerpendicular Constraint can be created from [macros](Macros.md) and from the python console by using the following: \n```python\n# direct perpendicularity\nSketch.addConstraint(Sketcher.Constraint('Perpendicular',icurve1,icurve2))\n\n# point-to-point perpendicularity\nSketch.addConstraint(Sketcher.Constraint('Perpendicular',icurve1,pointpos1,icurve2,pointpos2))\n\n# point-to-curve perpendicularity\nSketch.addConstraint(Sketcher.Constraint('Perpendicular',icurve1,pointpos1,icurve2))\n\n# perpendicular-via-point (plain constraint, helpers are not added automatically)\nSketch.addConstraint(Sketcher.Constraint('PerpendicularViaPoint',icurve1,icurve2,geoidpoint,pointpos)) \n``` where:\n\n - `Sketch` is a sketch object\n\n - `icurve1`, `icurve2` are two integers identifying the curves to be made perpendicular. The integers are indexes in the sketch (the value, returned by `Sketch.addGeometry`).\n\n - `pointpos1`, `pointpos2` should be `1` for start point and `2` for end point.\n\n - `geoidpoint` and `pointpos` in PerpendicularViaPoint are the indexes specifying the point of perpendicularity.\n\nThe [Sketcher scripting](Sketcher_scripting.md) page explains the values which can be used for `icurve1`, `icurve2`, `pointpos1`, `pointpos2` and `geoidpoint`, and contains further examples on how to create constraints from Python scripts.\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher ConstrainPerpendicular\n"} {"id": "freecad-docs:wiki/Sketcher_ConstrainRadius.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_ConstrainRadius.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_ConstrainRadius.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9b485aa452d82c2752dfc9525ac4b88a016e13a99690ad7aa5507ad2d08a1a2f", "bytes": 2440, "tokens": 839, "text": "---\n GuiCommand:\n Name: Sketcher ConstrainRadius\n MenuLocation: Sketch , Sketcher constraints , Constrain radius\n Workbenches: Sketcher_Workbench\n Shortcut: **K** **R**\n SeeAlso: Sketcher_ConstrainRadiam, Sketcher_ConstrainDiameter\n---\n\n# Sketcher ConstrainRadius\n\n## Description\n\nThe \"\" [Sketcher ConstrainRadius](Sketcher_ConstrainRadius.md) tool fixes the radius of circles, arcs and [B-spline weight circles](Sketcher_CreateBSpline#Notes.md).\n\n ![](images/Sketcher_ConstrainRadius_example.png ) \n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n### [Continue mode](Sketcher_Workbench#Continue_modes.md) \n\n1. Make sure there is no selection.\n2. There are several ways to invoke the tool:\n - \n (v1.0) \n \n : If the **Dimensioning constraints** [preference](Sketcher_Preferences#General.md) is set to {{Value|Single tool}} (default): press the down arrow to the right of the **** button and select the ** Constrain radius** option from the dropdown.\n\n - If this preference has a different value (and in {{VersionMinus|0.21}}): press the ** [Constrain radius](Sketcher_ConstrainRadius.md)** button.\n\n - Select the **Sketch → Sketcher constraints → Constrain radius** option from the menu.\n\n - \n (v1.0) \n \n : Right-click in the [3D view](3D_view.md) and select the **Dimension → Constrain radius** option from the context menu.\n\n - Use the keyboard shortcut: **K** then **R**.\n3. For further steps see [Sketcher ConstrainRadiam](Sketcher_ConstrainRadiam#Continue_mode.md).\n\n### Run-once mode \n\nSee [Sketcher ConstrainRadiam](Sketcher_ConstrainRadiam#Run-once_mode.md).\n\n## Scripting\n\n \n\nThe [Sketcher scripting](Sketcher_scripting.md) page explains the values which can be used for `ArcOrCircle`, and contains further examples on how to create constraints from Python scripts.\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher ConstrainRadius\n"} {"id": "freecad-docs:wiki/Sketcher_CopyClipboard.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_CopyClipboard.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_CopyClipboard.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "94064e249e42a446e1716d590f34130bf33035cd2bf1b1617ebe1028c9308d52", "bytes": 236, "tokens": 101, "text": "# Sketcher CopyClipboard\n1. REDIRECT [Sketcher_Workbench#Sketcher_CopyClipboard](Sketcher_Workbench#Sketcher_CopyClipboard.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher CopyClipboard\n"} {"id": "freecad-docs:wiki/Sketcher_Create3PointArc.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_Create3PointArc.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_Create3PointArc.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b10088ab35e57cb69bb1dec2d5fcd82ed1ce0a41820c6ee749ac5de1ad4bf5fb", "bytes": 1275, "tokens": 452, "text": "---\n GuiCommand:\n Name: Sketcher Create3PointArc\n MenuLocation: Sketch , Sketcher geometries , Create arc by 3 points\n Workbenches: Sketcher_Workbench\n Shortcut: **G** **3** **A**\n SeeAlso: Sketcher CreateArc\n---\n\n# Sketcher Create3PointArc\n\n## Description\n\nThe \"\" [Sketcher Create3PointArc](Sketcher_Create3PointArc.md) tool creates an arc by its endpoints and a point along the arc. (v1.0) : This is the same tool as [Sketcher CreateArc](Sketcher_CreateArc.md) but with a different initial mode.\n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n1. There are several ways to invoke the tool:\n - Press the ** [Endpoints and rim point](Sketcher_Create3PointArc.md)** button.\n - Select the **Sketcher → Sketcher geometries → Create arc by 3 points** option from the menu.\n - Use the keyboard shortcut: **G** then **3**, then **A**.\n2. For further steps see [Sketcher CreateArc](Sketcher_CreateArc#Usage.md).\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher Create3PointArc\n"} {"id": "freecad-docs:wiki/Sketcher_CreateArcOfEllipse.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_CreateArcOfEllipse.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_CreateArcOfEllipse.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "07019b9397882d34d16a3967bb243d72e1f9f56c7916892240591499ed7c7118", "bytes": 2357, "tokens": 780, "text": "---\n GuiCommand:\n Name: Sketcher CreateArcOfEllipse\n MenuLocation: Sketch , Sketcher geometries , Create arc of ellipse\n Workbenches: Sketcher_Workbench\n Shortcut: **G** **E** **A**\n Version: 0.15\n SeeAlso: Sketcher_CreateEllipseByCenter\n---\n\n# Sketcher CreateArcOfEllipse\n\n## Description\n\nThe \"\" [Sketcher CreateArcOfEllipse](Sketcher_CreateArcOfEllipse.md) tool creates an arc of ellipse.\n\n ![](images/Sketcher_CreateArcOfEllipse_Example.png ) \n*Arc of ellipse (white) with internal geometry (dark yellow)*\n\n## Usage\n\nSee also: [Drawing aids](Sketcher_Workbench#Drawing_aids.md).\n\n1. There are several ways to invoke the tool:\n - Press the ** [Arc of ellipse by center, radius, endpoints](Sketcher_CreateArcOfEllipse.md)** button.\n - Select the **Sketcher → Sketcher geometries → Create arc of ellipse** option from the menu.\n - Use the keyboard shortcut: **G** then **E**, then **A**.\n2. The cursor changes to a cross with the tool icon.\n3. Pick the center of the arc.\n4. Pick an endpoint of one of the axes of the arc, this also defines one of its radii.\n5. Pick the start point of the arc, this also defines the other radius of the arc.\n6. Pick the endpoint of the arc.\n7. The arc of ellipse is created, including a set of internal geometry (major axis, minor axis and two foci).\n8. If the tool runs in [continue mode](Sketcher_Workbench#Continue_modes.md):\n 1. Optionally keep creating arcs.\n 2. To finish, right-click or press **Esc**, or start another geometry or constraint creation tool.\n\n## Notes\n\n- Elements of the internal geometry can be deleted. They can be recreated at any time with [Sketcher RestoreInternalAlignmentGeometry](Sketcher_RestoreInternalAlignmentGeometry.md).\n- Once created, the major and minor axes of an arc of ellipse are strict and cannot be swapped by resizing. This is a consequence of the solver parametrization and the same strict behavior of [OpenCASCADE](OpenCASCADE.md). An arc of ellipse must be rotated to swap its axes.\n\n\n {{Sketcher Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher CreateArcOfEllipse\n"} {"id": "freecad-docs:wiki/Sketcher_Micro_Tutorial_-_Constraint_Practices.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_Micro_Tutorial_-_Constraint_Practices.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_Micro_Tutorial_-_Constraint_Practices.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a8856dcd3b212c86d2dafa59c40be27f1cddde8f2cfd26a37128076b99aabd01", "bytes": 10425, "tokens": 3336, "text": "---\n TutorialInfo:\n Topic: Sketcher\n Level: Beginner\n Time: 30 minutes\n Author: Mark Stephen and vocx\n FCVersion: 0.19\n Files: https://forum.freecadweb.org/viewtopic.php?f=36&p=371659#p371659 Sketcher Constraints practices\n---\n\n# Sketcher Micro Tutorial - Constraint Practices\n\n \n\n\n## Introduction\n\nThis tutorial was originally written by Quick61, and it was rewritten and reillustrated by vocx.\n\nThis tutorial is designed to help the new user become familiar with the best practices of constraining a [Sketch](Sketch.md) in the workflow of the \"\" [Sketcher Workbench](Sketcher_Workbench.md).\n\nThere is a general rule with constraints: the fewer amount of **datum constraints** (dimensions), the better.\n\nIt is preferable to use a **geometric constraint** in place of a dimensional one if possible. This has to do with the internal workings of the Sketcher\\'s constraint solver.\n\n## Setup\n\n1\\. Open FreeCAD, create a new empty document with **File → [ [New](Std_New.md)**.\n\n: 1.1. Switch to the [Sketcher Workbench](Sketcher_Workbench.md) from the [workbench selector](Std_Workbench.md), or the menu **[View](Std_View_Menu.md) → Workbench → Sketcher**.\n\nSome actions to remember:\n\n- Press the right mouse button, or press **Esc** in the keyboard once, to deselect the active tool in edit mode.\n- To exit the sketch edit mode, press the **Close** button in the [task panel](task_panel.md), or press **Esc** twice in the keyboard.\n- To enter again edit mode, double click on the sketch in the [tree view](tree_view.md), or select it, and then click on **[ [Edit sketch](Sketcher_EditSketch.md)**.\n\n## Create a sketch \n\n2\\. Click on ** [New sketch](Sketcher_NewSketch.md)**.\n\n: 2.1. Choose the sketch orientation, that is, one of the base XY, XZ, or YZ planes. We will use the default plane and options.\n: 2.2. Click **OK** to start constructing the sketch.\n\n\n**Note:**\n\nin the [task panel](task_panel.md) expand the **Edit controls** section, and make sure the **Auto constraints** option is disabled. Also turn off the grid snap, and hide the grid.\n\n## First approach: datum constraints \n\n3\\. We will draw a fully constrained square, centered at the origin.\n\n: 3.1. Click on ** [Create polyline](Sketcher_CreatePolyline.md)**, then trace four lines in the general shape of a rectangle around the origin.\n\n \"\" \n*Unconstrained rectangular sketch.*\n\n: 3.2. Select one horizontal line, and press **[ [Horizontal distance](Sketcher_ConstrainDistanceX.md)**, then enter {{Value|20 mm}}.\n: 3.3. Select the other horizontal line, and repeat the constraint with the same distance.\n: 3.4. Select one vertical line, and press **[ [Vertical distance](Sketcher_ConstrainDistanceY.md)**, then enter {{Value|20 mm}}.\n: 3.5. Select the other vertical line, and repeat the constraint with the same distance.\n: 3.6. Select one bottom corner point (a), and the origin of the sketch, and press **[ [Horizontal distance](Sketcher_ConstrainDistanceX.md)**, then enter {{Value|10 mm}}.\n: 3.7. Select the top corner point (b) above the previous corner point (a), and the origin of the sketch, and repeat the horizontal constraint with the same distance.\n: 3.8. Select the other bottom corner point (c), and the origin of the sketch, and press **[ [Vertical distance](Sketcher_ConstrainDistanceY.md)**, then enter {{Value|10 mm}}.\n: 3.9. Select the top corner point (b) again, and the origin of the sketch, and repeat the vertical constraint with the same distance.\n\n \"\" \"\" \n*Left: datum constraints for the sides. Right: additional datum constraints for the interior distances.*\n\nLooking at the **Constraints** section in the [task panel](task_panel.md), we see that the constraints are too many; they also clutter the view of the sketch. These constraints are also computationally intensive for the solver; while this is not an issue with a simple shape, it can become one with more complex shapes.\n\n## A better way: datum and geometric constraints \n\n4\\. We will draw the same square fully constrained, and centered at the origin. When you create the new sketch, make sure the **Auto constraints** option is disabled.\n\n: 4.1. Click on ** [Create polyline](Sketcher_CreatePolyline.md)**, then trace four lines in the general shape of a rectangle around the origin.\n: 4.2. Select one horizontal line, and press **[ [Horizontal](‎Sketcher_ConstrainHorizontal.md)**.\n: 4.3. Select the other horizontal line, and repeat the constraint.\n: 4.4. Select one vertical line, and press **[ [Vertical](‎Sketcher_ConstrainVertical.md)**.\n: 4.5. Select the other vertical line, and repeat the constraint.\n\n \"\" \n*Geometrical horizontal and vertical constraints.*\n\n: 4.6. Select one horizontal line, and press **[ [Horizontal distance](Sketcher_ConstrainDistanceX.md)**, then enter {{Value|20 mm}}. We see that the other horizontal line changes size at the same time.\n: 4.7. Select one vertical line, and press **[ [Vertical distance](Sketcher_ConstrainDistanceY.md)**, then enter {{Value|20 mm}}. We see that the other vertical line changes size at the same time.\n: 4.8. Select one bottom corner point (a), and the origin of the sketch, and press **[ [Horizontal distance](Sketcher_ConstrainDistanceX.md)**, then enter {{Value|10 mm}}.\n: 4.9. Select the top corner point (b) above the previous corner point (a), and the origin of the sketch, and press **[ [Vertical distance](Sketcher_ConstrainDistanceY.md)**, then enter {{Value|10 mm}}.\n\n \"\" \"\" \n*Left: datum constraints for only two sides. Right: additional datum constraints for only two interior distances.*\n\nThis is a better constrained sketch than the first one. The horizontal and vertical geometric constraints allow us to use fewer datum constraints, so our sketch looks less cluttered.\n\n## Optimum scheme: mostly geometric constraints \n\n5\\. We will draw the same square fully constrained, and centered at the origin. When you create the new sketch, make sure the **Auto constraints** option is disabled.\n\n: 5.1. Click on ** [Create polyline](Sketcher_CreatePolyline.md)**, then trace four lines in the general shape of a rectangle around the origin.\n: 5.2. Select one horizontal line, and press **[ [Horizontal](‎Sketcher_ConstrainHorizontal.md)**.\n: 5.3. Select the other horizontal line, and repeat the constraint.\n: 5.4. Select one vertical line, and press **[ [Vertical](‎Sketcher_ConstrainVertical.md)**.\n: 5.5. Select the other vertical line, and repeat the constraint.\n\n \"\" \n*Geometrical horizontal and vertical constraints.*\n\n: 5.6. Select one bottom corner point (a), then the top corner point that is diagonally opposite, and then the origin of the sketch; then press **[ [Symmetric](Sketcher_ConstrainSymmetric.md)**. The two selected points will be equidistant from the origin.\n: 5.7. Select two adjacent sides of the rectangle (connected at one corner), and press **[ [Equal length](Sketcher_ConstrainEqual.md)**. Notice that due to the symmetry of the corner points, all sides are now of the same size.\n\n \"\" \"\" \n*Left: symmetric constraint for only two corner points. Right: additional equal length distances for only two adjacent sides.*\n\n: 5.8. Select one horizontal line, and press **[ [Horizontal distance](Sketcher_ConstrainDistanceX.md)**, then enter {{Value|20 mm}}. Due to the symmetric and length equality constraints previously added, we see that all sides become equal at the same time.\n\n \"\" \n*All geometric constraints applied, and a single datum constraint for a side.*\n\nThis is the best way to constrain this sketch, as we only used one datum (dimensional) constraint.\n\n## Additional resources \n\n- [Basic Sketcher Tutorial](Basic_Sketcher_Tutorial.md)\n- [Sketcher Lecture](Sketcher_Lecture.md)\n- [Sketcher Tutorial](Sketcher_Tutorial.md)\n\n {{Sketcher Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher Micro Tutorial - Constraint Practices\n"} {"id": "freecad-docs:wiki/Sketcher_NewSketch.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_NewSketch.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_NewSketch.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "396a3f9db076ce61c1cddbee144d663a72d8eec14a755529aa1dd021b7aabb4d", "bytes": 2836, "tokens": 933, "text": "---\n GuiCommand:\n Name: Sketcher NewSketch\n MenuLocation: Sketch , Create sketch\n Workbenches: Sketcher_Workbench\n SeeAlso: PartDesign_NewSketch, Sketcher_MapSketch, Sketcher_ReorientSketch\n---\n\n# Sketcher NewSketch\n\n## Description\n\nThe \"\" [Sketcher NewSketch](Sketcher_NewSketch.md) tool creates a new sketch and opens the [Sketcher Dialog](Sketcher_Dialog.md) to edit it.\n\nNote that the \"\" [PartDesign Workbench](PartDesign_Workbench.md) has its own [new sketch](PartDesign_NewSketch.md) tool. When working on a [PartDesign Body](PartDesign_Body.md) that tool should be used instead.\n\n## Usage\n\n1. If the sketch should be [attached](Part_EditAttachment.md) to existing geometry: select an object with a shape, or one or more vertices, edges, and/or faces, and/or a plane.\n2. There are several ways to invoke the tool:\n - Press the ** [Create sketch](Sketcher_NewSketch.md)** button.\n - Select the **Sketch → Create sketch** option from the menu.\n3. If geometry has been selected:\n 1. The **Sketch attachment** dialog opens.\n 2. Select an [attachment method](Part_EditAttachment#Attachment_modes.md) from the dropdown list. Or select **Don\\'t attach** to ignore the selection.\n 3. Press the **OK** button.\n4. If there is no selection, or **Don\\'t attach** has been selected in the previous step:\n 1. The **Choose orientation** dialog opens.\n 2. Specify the plane for the orientation. The plane is relative to the local coordinate system the sketch is in:\n - If the **Reverse direction** checkbox is not checked:\n - Top: **XY-Plane**\n - Front: **XZ-Plane**\n - Right: **YZ-Plane**\n - If the **Reverse direction** checkbox is checked:\n - Bottom: **XY-Plane**\n - Rear: **XZ-Plane**\n - Left: **YZ-Plane**\n 3. Optionally change the **Offset**. The offset is measured along the Z, Y or X axis of the local coordinate system.\n 4. Press the **OK** button.\n5. A sketch is created.\n6. The sketch is put in edit mode and the [Sketcher Dialog](Sketcher_Dialog.md) opens.\n7. To finish edit mode see \"\" [Sketcher LeaveSketch](Sketcher_LeaveSketch.md).\n\n## Notes\n\n- Existing sketches can be attached to (different) object(s) with [Sketcher MapSketch](Sketcher_MapSketch.md) or detached and reoriented with [Sketcher ReorientSketch](Sketcher_ReorientSketch.md).\n\n\n {{Sketcher Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher NewSketch\n"} {"id": "freecad-docs:wiki/Sketcher_Paste.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_Paste.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_Paste.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "35e97efe0932993c0fc3e6855bbf1c35da21265589893b41165253bdca3bcc95", "bytes": 204, "tokens": 89, "text": "# Sketcher Paste\n1. REDIRECT [Sketcher_Workbench#Sketcher_Paste](Sketcher_Workbench#Sketcher_Paste.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher Paste\n"} {"id": "freecad-docs:wiki/Sketcher_SelectConstraints.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_SelectConstraints.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_SelectConstraints.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "e58515bb19166c2ae23577858f4e6f6a04ec1dfc4e25d5873bf800ac6cb5f139", "bytes": 1657, "tokens": 514, "text": "---\n GuiCommand:\n Name: Sketcher SelectConstraints\n MenuLocation: Sketch , Sketcher visual , Select associated constraints\n Workbenches: Sketcher_Workbench\n Shortcut: **Z** **K**\n Version: 0.15\n---\n\n# Sketcher SelectConstraints\n\n## Description\n\nThe \"\" [Sketcher SelectConstraints](Sketcher_SelectConstraints.md) tool selects the constraints associated with sketch elements.\n\n## Usage\n\n1. Select one or more sketch elements.\n2. There are several ways to invoke the tool:\n - Press the **[ [Select associated constraints](Sketcher_SelectConstraints.md)** button.\n\n - Select the **Sketch → Sketcher visual → [ Select associated constraints** option from the menu.\n\n - \n (v1.0) \n \n : Right-click in the [3D view](3D_view.md) and select the ** Select associated constraints** option from the context menu.\n\n - Right-click in the **Elements** section of the [Sketcher Dialog](Sketcher_Dialog.md) and select the ** Select Constraints** option from the context menu.\n\n - Use the keyboard shortcut: **Z** then **K**.\n3. The associated constraints are selected.\n4. Optionally click in an empty area in the [3D view](3D_view.md) to clear the selection.\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher SelectConstraints\n"} {"id": "freecad-docs:wiki/Sketcher_reference.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Sketcher_reference.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Sketcher_reference.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "7974e620a8f9ce5acc0c8145f248a397df102e9aa2a3f1bb379467116f915f3a", "bytes": 178, "tokens": 73, "text": "# Sketcher reference\n1. REDIRECT [Sketcher_Lecture](Sketcher_Lecture.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sketcher](Sketcher_Workbench.md) > Sketcher reference\n"} {"id": "freecad-docs:wiki/Standard_Menu.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Standard_Menu.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Standard_Menu.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2ca6a22d999815805f17fc05c8df58b56cb7128ff0cf71fca3144a931ca0fadb", "bytes": 1783, "tokens": 647, "text": "# Standard Menu\n## Introduction\n\nThe standard menu gives access to tools that can be used in all workbenches. The menu may look slightly different depending on the desktop environment (KDE, Gnome, Windows, macOS, etc.). Workbenches can also add sub-menus depending on how they decide to structure their tools.\n\n\n{{StdMenu\n|\n[File](Std_File_Menu.md)\n   \n[Edit](Std_Edit_Menu.md)\n   \n[View](Std_View_Menu.md)\n   \n[Tools](Std_Tools_Menu.md)\n   \n[Macro](Std_Macro_Menu.md)\n   \n[Windows](Std_Windows_Menu.md)\n   \n[Help](Std_Help_Menu.md)\n}}\n\n\n*The standard menu*\n\n## Sub-menus \n\nThe standard menu is composed of 7 sub-menus:\n\n- {{StdMenu|[File](Std_File_Menu.md)}}The File menu provides tools related to file input and output.\n\n- {{StdMenu|[Edit](Std_Edit_Menu.md)}}The Edit menu provides tools to change the model.\n\n- {{StdMenu|[View](Std_View_Menu.md)}}The View menu provides tools to change the [3D view](3D_view.md) and the view properties of objects in the model, and tools related to the display of interface components.\n\n- {{StdMenu|[Tools](Std_Tools_Menu.md)}}The Tools menu provides tools for debugging models, customizing FreeCAD\\'s behavior, as well as auxiliary tools.\n\n- {{StdMenu|[Macro](Std_Macro_Menu.md)}}The Macro menu provides tools related to the recording and execution of [macros](Macros.md).\n\n- {{StdMenu|[Windows](Std_Windows_Menu.md)}}The Windows menu allows switching and rearranging of [Main view area](Main_view_area.md) windows.\n\n- {{StdMenu|[Help](Std_Help_Menu.md)}}The Help menu provides access to the help system and links to the FreeCAD website and forum.\n\n {{Interface navi}}\n\n\n---\n⏵ [documentation index](../README.md) > Standard Menu\n"} {"id": "freecad-docs:wiki/Std_ActivatePrevWindow.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_ActivatePrevWindow.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_ActivatePrevWindow.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a4742059174d837d2c9ed6ce857ba7500a96c37083e5402dff2f4d5b6c0a502d", "bytes": 925, "tokens": 292, "text": "---\n GuiCommand:\n Name: Std ActivatePrevWindow\n MenuLocation: Windows , Previous\n Workbenches: All\n Shortcut: **Ctrl**+**Shift**+**Tab**\n SeeAlso: Std_ActivateNextWindow, Std_Windows\n---\n\n# Std ActivatePrevWindow\n\n## Description\n\nThe **Std ActivatePrevWindow** command activates the previous window in the [Main view area](Main_view_area.md). The previous window is determined by the tabs order in Main view area.\n\n## Usage\n\n1. The Main view area must contain at least two windows.\n2. There are several ways to invoke the command:\n - Select the **Windows → Previous** option from the menu.\n - Use the keyboard shortcut: **Ctrl**+**Shift**+**Tab**.\n\n## Notes\n\n- The first 10 Main view area windows are also listed in the **Windows** menu and can be activated from there.\n\n\n---\n⏵ [documentation index](../README.md) > Std ActivatePrevWindow\n"} {"id": "freecad-docs:wiki/Std_AddonMgr.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_AddonMgr.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_AddonMgr.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "c5cef993de3ba767722411ee78acc00e022e2ede80a87fd412df89c21625d3ec", "bytes": 9472, "tokens": 2676, "text": "---\n GuiCommand:\n Name: Std AddonMgr\n MenuLocation: Tools , Addon manager\n Workbenches: All\n Version: 0.17\n SeeAlso: External_workbenches, Macros\n---\n\n# Std AddonMgr\n\n## Description\n\nThe **Std AddonMgr** command opens the Addon manager. With the Addon manager you can install and manage [external workbenches](external_workbenches.md), [macros](macros.md), and [preference packs](Preference_Packs.md) provided by the FreeCAD community. By default the available addons are taken from two repositories, [FreeCAD-addons](https://github.com/FreeCAD/FreeCAD-addons/) and from the [Macros recipes](Macros_recipes.md) page. If GitPython and git are installed on your system, additional macros will be loaded from [FreeCAD-macros](https://github.com/FreeCAD/FreeCAD-macros/). Custom repositories can be added in the [Addon manager preferences](Preferences_Editor#Addon_Manager.md).\n\nDue to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version [0.18.5](https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5) or later. Alternatively you can install addons manually, see [Notes](#Notes.md) below.\n\n## Usage\n\n1. Select the **Tools → Addon manager** option from the menu.\n2. If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. It also presents several options related to the Addon manager\\'s data usage. Adjust those options to your liking and press the **OK** button to confirm and continue.\n3. The Addon manager dialog box opens. For more information see [Options](#Options.md).\n4. If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.\n\n## Options\n\n \"\" \n\n1. The Addon manager provides two view layouts: \\\"Condensed\\\" and \\\"Expanded\\\". In \\\"Condensed\\\" view, each addon takes a single line, and its description is truncated to fit the available space. \\\"Expanded\\\" shows additional details, including more of the description text as well as maintainer information, more installation details, etc.\n2. Three different types of addons are supported: [workbenches](external_workbenches.md), [macros](macros.md), and [preference packs](Preference_Packs.md). You can choose to show just one type, or all of them in a single list.\n3. The list can be limited to show just installed packages, just packages with available updates, or just packages that are not yet installed.\n4. The list can be filtered, searching for a keyword in the title, description, and tags (description and tags must be specified by the addon developer in their addon\\'s metadata). The filter can even be a regular expression, for fine-grained control of the exact search term.\n5. The expanded view shows available version information, description, maintainer information, and installation version information, for packages that provide a [package metadata](Package_Metadata.md) file (or for macros with embedded metadata).\n6. Addon data is cached locally, with a variable cache update frequency set in the user preferences.\n7. At any time you can choose to manually update your local cache to see the latest updates available for each addon.\n8. Update checks may be set up to be automatic, or done manually via a button click (configured in user preferences). If GitPython and git are installed on your system then update information is fetched using git. If not, then update information is obtained from any present metadata file.\n\nClicking on an addon in this view brings up the addon\\'s Details page:\n\n \"\" \n\nThe details page shows buttons allowing installing, uninstalling, updating, and temporarily disabling an addon. For installed addons it lists the currently installed version and the installation date, and whether that is the most recent version available. Below is an embedded web browser window showing the addon\\'s README page (for workbenches and preference packs), or Wiki page (for macros).\n\n## Preferences\n\nThe preferences for the Addon manager can be found in the [Preferences Editor](Preferences_Editor#Addon_Manager.md). (v0.20) \n\n## Sorting by score \n\n\n(v1.0) \n\nThe Addon Manager supports sorting by a number of different criteria. Most of these are downloaded directly from FreeCAD\\'s servers (which caches them from GitHub and the FreeCAD Wiki) but one, \\\"Score,\\\" is not provided by FreeCAD at all, and only appears as an option if the Score Source URL setting is provided in the Preferences.\n\nThe Score Source URL is a path to a remote JSON-formatted document listing addons and a \\\"score\\\" of some kind. Score can be calculated in any way the data provider likes, but should be an integer value, with higher scores being \\\"better\\\" in some sense. Any addon not listed is assigned a score of zero internally. The format of the file is a single JSON dictionary where the key is the addon URL (for workbenches and preference packs) or the name of the macro (for macros). See [this data source](https://gist.githubusercontent.com/chennes/e8f60e80f16e6ffbd057dd47ca36ad2a/raw/7b118cca8e84444c3379919bbd744b99e6ef6711/addon_score_for_testing.json) for an example (note the score there is simply the length of the addon\\'s description, and is intended only for testing and demonstration purposes).\n\n## Notes\n\n- The use of addons is not restricted to the FreeCAD version they were installed from. You will also be able to use them in any other FreeCAD version, supported by the addon, that you may have on your system.\n- The addons available in the Addon manager are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the provided information carefully to make sure you know what you are installing.\n- Bug reports and feature requests should be made directly to the creator of the addon by visiting the indicated website. Many addon developers are regular users of the [FreeCAD forum](https://forum.freecadweb.org), and can also be contacted there.\n- If the [GitPython](https://github.com/gitpython-developers/GitPython) package is installed on your computer the Addon manager will use it, making downloads faster.\n- You can also install addons manually. See [How to install additional workbenches](How_to_install_additional_workbenches.md) and [How to install macros](How_to_install_macros.md).\n\n## Information for addon developers \n\nSee [Addon](Addon#Information_for_developers.md).\n\n## Scripting\n\n\n(v0.21) \n\nSome features of the Addon manager are designed for access via FreeCAD\\'s Python API. In particular an addon can be installed, updated, and removed via the Python interface. Most uses of this API require you to create an object with at least three attributes: {{Incode|name}}, {{Incode|branch}} and {{Incode|url}}. For example:\n\n \n```python\nclass MyAddonClass:\n def __init__(self):\n self.name = \"TestAddon\"\n self.url = \"https://github.com/Me/MyTestAddon\"\n self.branch = \"main\"\nmy_addon = MyAddonClass()\n```\n\nYour object {{Incode|my_addon}} is now ready for use with the Addon manager API.\n\n### Commandline (non-GUI) use \n\nIf your code needs to install or update an addon synchronously (e.g. without a GUI) the code can be very simple:\n\n \n```python\nfrom addonmanager_installer import AddonInstaller\ninstaller = AddonInstaller(my_addon)\ninstaller.run()\n```\n\nNote that this code blocks until complete, so you shouldn\\'t run it on the main GUI thread. To the Addon manager, \\\"install\\\" and \\\"update\\\" are the same call: if this addon is already installed, and git is available, it will be updated via \\\"git pull\\\". If it is not installed, or was installed via a non-git installation method, it is downloaded from scratch (using git if available).\n\nTo uninstall, use:\n\n \n```python\nfrom addonmanager_uninstaller import AddonUninstaller\nuninstaller = AddonUninstaller(my_addon)\nuninstaller.run()\n```\n\n### GUI use \n\nIf you plan on your code running in a GUI, or supporting running in the full version of FreeCAD, it\\'s best to run your installation in a separate non-GUI thread, so the GUI remains responsive. To do this, first check to see if the GUI is running, and if it is, spawn a {{Incode|QThread}} (don\\'t try to spawn a {{Incode|QThread}} if the GUI is not up: they require an active event loop to function).\n\n \n```python\nfrom PySide import QtCore\nfrom addonmanager_installer import AddonInstaller\n\nworker_thread = QtCore.QThread()\ninstaller = AddonInstaller(my_addon)\ninstaller.moveToThread(worker_thread)\ninstaller.success.connect(installation_succeeded)\ninstaller.failure.connect(installation_failed)\ninstaller.finished.connect(worker_thread.quit)\nworker_thread.started.connect(installer.run)\nworker_thread.start() # Returns immediately\n```\n\nThen define the functions {{Incode|installation_succeeded}} and {{Incode|installation_failed}} to be run in each case. For uninstallation you can use the same technique, though it is usually much faster and will not block the GUI for very long, so in general it\\'s safe to use the uninstaller directly, as shown above.\n\n\n---\n⏵ [documentation index](../README.md) > Std AddonMgr\n"} {"id": "freecad-docs:wiki/Std_BoxSelection.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_BoxSelection.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_BoxSelection.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9c4731964fbd054ebb342e3ae06271e2b54368d39f08175990a5145ac53e1fde", "bytes": 1174, "tokens": 359, "text": "---\n GuiCommand:\n Name: Std BoxSelection\n MenuLocation: Edit , Box selection\n Workbenches: All\n Shortcut: **Shift**+**B**\n SeeAlso: Std_BoxElementSelection, Std_SelectAll\n---\n\n# Std BoxSelection\n\n## Description\n\nThe **Std BoxSelection** command selects objects from a user defined rectangular area, a box, in the [3D view](3D_view.md).\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Select the **Edit → Box selection** option from the menu.\n - Use the keyboard shortcut: **Shift**+**B**.\n2. Do one of the following:\n - Drag a rectangle from left to right to select objects whose geometric center lies inside the rectangle.\n - Drag a rectangle from right to left to select objects whose bounding box is (partially) inside the rectangle, or touches it.\n\n## Notes\n\n- Use the [Std BoxElementSelection](Std_BoxElementSelection.md) command to box select faces instead of objects.\n- This command cannot be used to select elements in a sketch. See [Sketcher Workbench](Sketcher_Workbench#Selection_methods.md).\n\n\n---\n⏵ [documentation index](../README.md) > Std BoxSelection\n"} {"id": "freecad-docs:wiki/Std_DrawStyle.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_DrawStyle.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_DrawStyle.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "41711743ba0bd2826d303f61eac723cab3e4b021f0e6e3980736ea228cd829ce", "bytes": 3881, "tokens": 1294, "text": "---\n GuiCommand:\n Name: Std DrawStyle\n MenuLocation: View , Draw style , ...\n Workbenches: All\n Shortcut: **V** **1** - **V** **7**\n SeeAlso: Std_SelBoundingBox\n---\n\n# Std DrawStyle\n\n## Description\n\nThe **Std DrawStyle** command can override the effect of the **Display Mode** [property](Property_editor.md) of objects in a [3D view](3D_view.md).\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Click on the black down arrow to the right of the ** [Draw style](Std_DrawStyle.md)** button and select a style from the flyout.\n - In the menu go to **View → Draw style** and select a style.\n - In the [3D view](3D_view.md) context menu go to **Draw style** and select a style.\n - Use one of the keyboard shortcut: **V** then **1**, **2**, **3**, **4**, **5**, **6** or **7**.\n\n## Available draw styles \n\n### \"\" As is \n\nThe **As is** style does not override the **Display Mode** of objects.\n\n ![](images/Std_DrawStyleAsIs_example.png ) \n*4 identical objects each with a different Display Mode (from left to right: 'Points', 'Wireframe', 'Shaded' and 'Flat lines') with the 'As is' draw style applied*\n\n### \"\" Points \n\nThe **Points** style overrides the **Display Mode** of objects. This style matches the \\'Points\\' Display Mode. Vertices are displayed in solid colors. Edges and faces are not displayed.\n\n ![](images/Std_DrawStylePoints_example.png ) \n*The same objects with the 'Points' draw style applied*\n\n### \"\" Wireframe \n\nThe **Wireframe** style overrides the **Display Mode** of objects. This style matches the \\'Wireframe\\' Display Mode. Vertices and edges are displayed in solid colors. Faces are not displayed.\n\n ![](images/Std_DrawStyleWireframe_example.png ) \n*The same objects with the 'Wireframe' draw style applied*\n\n### \"\" Hidden line \n\nThe **Hidden line** style overrides the **Display Mode** of objects. Objects are displayed as if converted to triangular meshes.\n\n ![](images/Std_DrawStyleHiddenLine_example.png ) \n*The same objects with the 'Hidden line' draw style applied*\n\n### \"\" No shading \n\nThe **No shading** style overrides the **Display Mode** of objects. Vertices, edges and faces are displayed in solid colors.\n\n ![](images/Std_DrawStyleNoShading_example.png ) \n*The same objects with the 'No shading' draw style applied*\n\n### \"\" Shaded \n\nThe **Shaded** style overrides the **Display Mode** of objects. This style matches the \\'Shaded\\' Display Mode. Vertices and edges are not displayed. Faces are illuminated depending on their orientation.\n\n ![](images/Std_DrawStyleShaded_example.png ) \n*The same objects with the 'Shaded' draw style applied*\n\n### \"\" Flat lines \n\nThe **Flat lines** style overrides the **Display Mode** of objects. This style matches the \\'Flat lines\\' Display Mode. Vertices and edges are displayed in solid colors. Faces are illuminated depending on their orientation.\n\n ![](images/Std_DrawStyleFlatLines_example.png ) \n*The same objects with the 'Flat lines' draw style applied*\n\n## Notes\n\n- Objects in a [3D view](3D_view.md) also have a **Draw Style** property. This property controls the linetype used for the edges. The Std DrawStyle command does not override this property.\n- For a macro to toggle between two draw styles see: [Macro Toggle Drawstyle](Macro_Toggle_Drawstyle.md).\n\n\n---\n⏵ [documentation index](../README.md) > Std DrawStyle\n"} {"id": "freecad-docs:wiki/Std_FreeCADPowerUserHub.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_FreeCADPowerUserHub.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_FreeCADPowerUserHub.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0ecae6e7a2f5940e5fc3411638e05e0c3807270b5fc621c2a001fd4d55e81605", "bytes": 786, "tokens": 259, "text": "---\n GuiCommand:\n Name: Std FreeCADPowerUserHub\n MenuLocation: Help , Python scripting documentation\n Workbenches: All\n SeeAlso: Std_FreeCADWebsite, Std_FreeCADUserHub, Std_FreeCADForum, Std_FreeCADFAQ\n---\n\n# Std FreeCADPowerUserHub\n\n## Description\n\nThe **Std FreeCADPowerUserHub** command opens the FreeCAD Power users documentation page in the system\\'s default Internet browser. The command requires a working Internet connection.\n\nCurrently the command points to [](https://wiki.freecad.org/Power_users_hub).\n\n## Usage\n\n1. Select the **Help → Python scripting documentation** option from the menu.\n\n\n---\n⏵ [documentation index](../README.md) > Std FreeCADPowerUserHub\n"} {"id": "freecad-docs:wiki/Std_Measure.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_Measure.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_Measure.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "15c23aef48fd0b39f6fe285a0f3fdccb882f4257797401d07002688954378fa0", "bytes": 4573, "tokens": 1281, "text": "---\n GuiCommand:\n Name: Std Measure\n MenuLocation: Tools , Measure\n Workbenches: All\n Version: 1.0\n SeeAlso: Draft_Dimension\n---\n\n# Std Measure\n\n## Description\n\nThe **Std Measure** command gives access to the Unified Measurement Facility. It replaces several previous measurement commands, providing a versatile measurement functionality.\n\n## Usage\n\n1. Optionally preselect the entities to be measured.\n2. There are several ways to invoke the command:\n - Press the ** [Std Measure](Std_Measure.md)** button.\n - Select the **Tools → Measure** option from the menu.\n3. The **Measurement** task panel opens. See [Options](#Options.md) for more information.\n4. If no geometrical entities were preselected, do one of the following:\n - Select the geometrical entities while leaving the *Mode* as *Auto* so that the mode will be automatically determined based on the selection.\n - Choose a *Mode* other than *Auto* and then select the geometrical entities (clicking on them again will deselect them):\n - *Distance* - the shortest distance between the selected entities, if circular edges are selected then the distance between the centers of the circles is measured,\n - *Distance Free* - distance between two freely selected points (belonging to different entities - edges, faces),\n - *Angle* - angle between the selected entities,\n - *Length* - length of the selected edge,\n - *Position* - coordinates of the selected vertex,\n - *Area* - area of the selected face,\n - *Radius* - radius of the selected circular edge,\n - *Center of Mass* - COM of the selected edge, face or solid (only if preselected in the tree).\n5. The measurement result will be shown in the *Result* field and on a label displayed in the [3D view](3D_view.md). That label will also include an icon indicating the type of measurement. The labels can be customized in the [Preferences](Preferences_Editor.md). They can be moved in the 3D view by dragging them with a cursor.\n6. Press the **Reset** button to delete the measurement or the **Save** button to keep it. Saved measurements are put in a Measurements [group](Std_Group.md) in the [Tree view](Tree_view.md).\n7. Press **Esc** or the **Close** button to finish the command.\n\n## Options\n\n- (v1.1) Press the ** ** button to change the settings:\n\n - *Auto Save* - if checked, the last measurement is saved when starting a new measurement (holding **Shift** can temporarily disable this behavior),\n - *Additive Selection* - if checked, clicking on subsequent geometrical entities adds them as selections for the same measurement, otherwise **Ctrl** must be pressed to do this.\n\n- For the *Distance* and *Distance Free* modes the **Show Delta** checkbox is displayed. If this checkbox is checked, the **Show Delta** property of the measurement is set to `True` and 3 additional projected measurements are shown in the [3D view](3D_view.md).\n\n## Properties\n\n### Data\n\n\n{{TitleProperty|Measurement}}\n\n- **Element1|LinkSub**: First element of the measurement.\n\n- **Element2|LinkSub**: Second element of the measurement.\n\n- **Distance|Distance**: Distance between the two elements.\n\n- **Distance X|Distance**: Distance in the X direction (only for *Distance* and *Distance Free* measurements).\n\n- **Distance Y|Distance**: Distance in the Y direction (idem).\n\n- **Distance Z|Distance**: Distance in the Z direction (idem).\n\n- **Position1|Vector|Hidden**: Position of the first measured point (read-only).\n\n- **Position2|Vector|Hidden**: Position of the second measured point (read-only).\n\n### View\n\n\n{{TitleProperty|Appearance}}\n\n- **Font Size|Integer**: Defines the font size for the label of the saved dimension.\n\n- **Line Color|Color**: Defines the color of the dimension lines displayed in 3D view.\n\n- **Show Delta|Bool**: If `True`, projected distance measurements are displayed in 3D view (only for *Distance* and *Distance Free* measurements).\n\n- **Text Background Color|Color**: Defines the background color of the dimension label.\n\n- **Text Color|Color**: Defines the color of the dimension label text and symbol.\n\n## Notes\n\n- This command is the result of a [GSoC 2023 project](Unified_Measurement_Facility.md).\n\n\n---\n⏵ [documentation index](../README.md) > Std Measure\n"} {"id": "freecad-docs:wiki/Std_SaveaCopy.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_SaveaCopy.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_SaveaCopy.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "fde0aff1f4d70b07448fc995fb5a8cc0bdf82dc6f5088aadc366af567716364d", "bytes": 124, "tokens": 63, "text": "# Std SaveaCopy\n1. REDIRECT [Std_SaveCopy](Std_SaveCopy.md)\n\n\n---\n⏵ [documentation index](../README.md) > Std SaveaCopy\n"} {"id": "freecad-docs:wiki/Std_ViewBottom.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Std_ViewBottom.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Std_ViewBottom.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f52e4dabe22243863996dac7698d423a6b8ea1f23770ba5777e13874cfac2746", "bytes": 1042, "tokens": 364, "text": "---\n GuiCommand:\n Name: Std ViewBottom\n MenuLocation: View , Standard views , Bottom\n Workbenches: All\n Shortcut: **5**\n SeeAlso: Std_ViewRear, Std_ViewLeft\n---\n\n# Std ViewBottom\n\n## Description\n\nThe **Std ViewBottom** command points the camera in the active [3D view](3D_view.md) in the direction of the positive Z axis.\n\n ![](images/FreeCAD_views_rear.svg ) \n*Arrow 5 points in the direction of the bottom view*\n\n## Usage\n\n1. There are several ways to invoke the command:\n - Press the ** [Bottom](Std_ViewBottom.md)** button.\n - Select the **View → Standard views → Bottom** option from the menu.\n - Select the **Standard views → Bottom** option from the [3D view](3D_view.md) context menu.\n - Use the keyboard shortcut: **5**.\n\n## Scripting\n\nSee [Std ViewFront](Std_ViewFront#Scripting.md).\n\n\n---\n⏵ [documentation index](../README.md) > Std ViewBottom\n"} {"id": "freecad-docs:wiki/Stemfie_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Stemfie_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Stemfie_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "701b7d2a08abd617dc927999842ada86aa5754e54766331103b4eb33aba3fa4f", "bytes": 2309, "tokens": 894, "text": "# \"STEMFIE Stemfie Workbench\n\n \n\n## Introduction\n\nThe Stemfie Workbench is an [external workbench](External_workbenches.md) aimed at implementing a parametric set of parts for the [Stemfie project](https://www.stemfie.org/).\n\n ![Stemfie Workbench set of parts\\|700px](images/Stemfie_WB.jpg ) \n\n## Installing\n\nThe Stemfie Workbench is not bundled with the default FreeCAD package, but can easily be installed via the \"\" [Addon Manager](Std_AddonMgr.md). Invoke it from **Tools → [Addons Manager](Std_AddonMgr.md)**. The Stemfie Workbench code is [hosted and developed on github](https://github.com/bilbaomakers/StemfieWB) and can also be installed manually by copying it into FreeCAD\\'s **MOD** directory.\n\n## Tools\n\n### Beams\n\n- Beam - Straight - End Square Square\n- Beam - Straight - End Round Round\n\n### Braces\n\n- Brace - Straight - Standard - End Round Round\n\n### Connectors\n\n- Connector - Through-Hole - Beam - Shaft - One-way\n- Connector - Through-Hole - Beam - Shaft - Two-way 90°\n- Connector - Through-Hole - Beam - Shaft - Two-way 180°\n- Connector - Through-Hole - Beam - Shaft - Three-way\n- Connector - Through-Hole - Beam - Shaft - Four-way\n\n### Plates\n\n- Triangular plate\n- Square plate\n- Hexagonal plate\n\n### Shaft\n\n- Shaft plain\n\n## References\n\n- Author: Bilbao Makers, [User:hasecilu](User_hasecilu.md)\n- Source code: \n- Bug reports and feature requests: \n- Forum topic: \n- File name structure: \n\n## Documents\n\n- [README](https://github.com/bilbaomakers/StemfieWB/blob/main/README.md)\n- [CHANGELOG](https://github.com/bilbaomakers/StemfieWB/blob/main/CHANGELOG.md)\n- [CONTRIBUTING](https://github.com/bilbaomakers/StemfieWB/blob/main/CONTRIBUTING.md)\n- [TRANSLATION](https://github.com/bilbaomakers/StemfieWB/blob/main/freecad/stemfie/resources/translations/README.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [External_Workbenches](Category_External_Workbenches.md) > Stemfie Workbench\n"} {"id": "freecad-docs:wiki/Surface_Sections.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Surface_Sections.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Surface_Sections.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "5a07443c0dc607465358fb87933e5513a0b1df5e59e27eed6d5eb9a3e9110e59", "bytes": 5334, "tokens": 1753, "text": "---\n GuiCommand:\n Name: Surface Sections\n MenuLocation: Surface , Sections\n Workbenches: Surface_Workbench\n Version: 0.19\n---\n\n# Surface Sections\n\n## Description\n\n\n**[ [Surface Sections](Surface_Sections.md)**\n\nis used to create a surface from edges that represent transversal sections of a surface.\n\n \"\" \"\" \n\n\n*Left: control edges (transversal sections). Right: surface produced from these edges.*\n\n## Usage\n\n1. Make sure you have at least two edges or curves in space. For example, these can be created with tools of the \"\" [Draft Workbench](Draft_Workbench.md) or the \"\" [Sketcher](Sketcher_Workbench.md).\n2. Press the **[ [Surface sections](Surface_Sections.md)** button.\n3. Press **Add edge**.\n4. Use the pointer to pick the desired edges in the [3D view](3D_view.md); a preview of the final shape will be shown after selecting two valid edges.\n5. Press **OK** to complete the operation.\n\n## Options\n\n- **Add edge**: press once to start picking edges in the [3D view](3D_view.md). Individual lines such as **[ [Draft BSplines](Draft_BSpline.md)** and **[ [Sketcher BSplines](Sketcher_CreateBSpline.md)** can be chosen, as well as any edge from solid objects, like those of **[ [PartDesign Bodies](PartDesign_Body.md)** and **[ [Part Primitives](Part_Primitives.md)**.\n\n- **Remove edge**: press once to start picking edges in the [3D view](3D_view.md); these must be edges that were previously picked with **Add edge**.\n\n- **Right mouse button**: open the context menu and select **Remove**, or press **Del** in the keyboard, to remove the currently selected edge in the list.\n\n- **Drag**: drag the currently selected element in the list in order to change the order in which it will be processed; the list is processed from top to bottom.\n\n- Press **Cancel** or **Esc** to abort the current operation.\n\n## Properties\n\nA [Surface Sections](Surface_Sections.md) (`Surface::Sections` class) is derived from the basic [Part Feature](Part_Feature.md) (`Part::Feature` class, through the `Part::Spline` subclass), therefore it shares all the latter\\'s properties.\n\nIn addition to the properties described in [Part Feature](Part_Feature.md), the Surface Sections has the following properties in the [property editor](property_editor.md).\n\n### Data\n\n\n{{TitleProperty|Sections}}\n\n- **NSections|LinkSubList**: a list of edges that will be used to build the surface.\n\n### View\n\n\n{{TitleProperty|Base}}\n\n- **Control Points|Bool**: it defaults to `False`; if set to `True`, it will show an overlay with the control points of the surface.\n\n## Twisting of the surface \n\nThe shape of the surface depends on the direction of the chosen edges; if edges are selected and the result is a surface that \\\"twists\\\" on itself, one of the edges may need its list of vertices in the reverse order. See the information in **[ [GeomFillSurface](Surface_GeomFillSurface.md)** for a more complete explanation.\n\n \"\" \"\" \n\n## Scripting\n\n\n**See also:**\n\n[FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe Surface Sections tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by adding the `Surface::Sections` object.\n\n- The edges to be used to define the surface must be assigned as a [LinkSubList](FeaturePython_Custom_Properties#App:_PropertyLinkSubList.md) to the `NSections` property of the object.\n- All objects with edges need to be computed before they can be used as input for the properties of the Sections object.\n\n \n```python\nimport FreeCAD as App\nimport Draft\n\ndoc = App.newDocument()\n\npl1 = App.Placement()\nobj1 = Draft.make_circle(50, placement=pl1, face=False, startangle=0, endangle=180)\n\npl2 = App.Placement(App.Vector(0, 0, 25), App.Rotation())\nobj2 = Draft.make_circle(30, placement=pl2, face=False, startangle=0, endangle=180)\n\npoints3 = [App.Vector(18, -10, 50),\n App.Vector(12, 10, 50),\n App.Vector(-12, 10, 50),\n App.Vector(-18, -10, 50)]\nobj3 = Draft.make_bspline(points3)\n\npoints4 = [App.Vector(15, -20, 100),\n App.Vector(0, 6, 100),\n App.Vector(-15, -20, 100)]\nobj4 = Draft.make_bspline(points4)\ndoc.recompute()\n\nsurf = doc.addObject(\"Surface::Sections\", \"Surface\")\nsurf.NSections = [(obj1, \"Edge1\"),\n (obj2, \"Edge1\"),\n (obj3, \"Edge1\"),\n (obj4, \"Edge1\")]\ndoc.recompute()\n```\n\n\n {{Surface Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Surface](Surface_Workbench.md) > Surface Sections\n"} {"id": "freecad-docs:wiki/Talk;Reqrefusion.wikitext.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Talk;Reqrefusion.wikitext.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Talk;Reqrefusion.wikitext.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0f861318a467f0b31d45decdba8bc5dad214cc168b5d5ba35de8530789b21979", "bytes": 104, "tokens": 41, "text": "# Talk;Reqrefusion.wikitext\n\n\n---\n⏵ [documentation index](../README.md) > Talk;Reqrefusion.wikitext\n"} {"id": "freecad-docs:wiki/TechDraw_ArchView.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_ArchView.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_ArchView.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "bd8ac6c68b042bc9e46bef69ae6bbb02438e9c625756f0f69b02ab6d689cedbc", "bytes": 5208, "tokens": 1621, "text": "---\n GuiCommand:\n Name: TechDraw ArchView\n MenuLocation: TechDraw , Views From Other Workbenches , Insert BIM Workbench Object\n Workbenches: TechDraw_Workbench, BIM_Workbench\n SeeAlso: Arch_SectionPlane\n---\n\n# TechDraw ArchView\n\n## Description\n\nThe **TechDraw ArchView** tool inserts an Arch View, a view of an \"\" [Arch SectionPlane](Arch_SectionPlane.md), on a [TechDraw page](TechDraw_PageDefault.md).\n\n\n(v1.0) \n\n: The [TechDraw View](TechDraw_View.md) tool can also create an Arch View.\n\n \"\" \n\n## Usage\n\n1. Select an Arch section plane in the [3D view](3D_view.md) or [Tree view](Tree_view.md).\n2. If there are multiple drawing pages in the document: optionally add the desired page to the selection by selecting it in the [Tree view](Tree_view.md).\n3. Select the **TechDraw → Views From Other Workbenches → Insert BIM Workbench Object** option from the menu.\n4. If there are multiple drawing pages in the document, and if no page is displayed in the [Main view area](Main_view_area.md) and you have not yet selected a page, the **Page Chooser** dialog box opens:\n 1. Select the desired page.\n 2. Press the **OK** button.\n\n## Options\n\n- The Arch View is rendered by the [BIM Workbench](BIM_Workbench.md).\n- [Draft Dimensions](Draft_Snap_Dimensions.md), [Draft Texts](Draft_Text.md) and any other 2D (Sketch or Draft) object considered by the section plane is rendered \\\"as is\\\" (no intersection or hidden lines) on top of the solid geometry\n- The volume of [Arch Spaces](Arch_Space.md) is not rendered, only the label will be rendered\n- Cut lines, projected lines (if Show Hidden property is set to True) and 2D lines above can be rendered with different line widths. This can be configured in the Arch preferences.\n- The ArchView has two rendering modes:\n - Wireframe, which uses the OpenCasCade algorithms of the [TechDraw Workbench](TechDraw_Workbench.md), is fast and produces only lines (no face fill possible)\n - Solid, which is based on the [Painter\\'s algorithm](https://en.wikipedia.org/wiki/Painter%27s_algorithm), and is capable of rendering faces filled with their shape color. However, it is much slower and can fail in many situations.\n\n: The image below illustrates the difference between the two rendering modes:\n\n\n: ![](images/TechDraw_Arch_rendering.jpg )\n- Only the base line of [Arch Pipes](Arch_Pipe.md) is rendered, not the full volume of the tube:\n\n\n: ![](images/TechDraw_Arch_piping.jpg )\n\n\n## Notes\n\nThe ArchView is rendered within the [BIM Workbench](BIM_Workbench.md), therefore TechDraw has limited control over its appearance. You may need to make changes within Arch to get the representation you want.\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nAn Arch View, formally a {{Incode|TechDraw::DrawViewArch}} object, has the [properties](TechDraw_View#Properties_Part_View.md) that are common to all View types. It also has the following additional properties:\n\n### Data\n\n\n{{TitleProperty|Arch view}}\n\n- **Source|Link**: The section plane object to be displayed.\n\n- **All On|Bool**: If hidden objects must be shown or not. If `False`, only objects that are visible in the 3D view are rendered.\n\n- **Render Mode|Enumeration**: The render mode to use, {{Value|Solid}} or {{Value|Wireframe}}.\n\n- **Fill Spaces|Bool**: If `True`, Arch Spaces are shown as a colored area.\n\n- **Show Hidden|Bool**: If the hidden geometry (the part of the geometry that lies behind the section plane) is shown or not. It will be rendered in dashed line, which can be configured in the Arch preferences.\n\n- **Show Fill|Bool**: If cut areas must be filled with a grey color or not.\n\n- **Line Width|Float**: The width of the main lines. Cut lines and projected/2D line widths ratios can be configured in the Arch preferences.\n\n- **Font Size|Float**: The size of all texts that appear in this view.\n\n- **Cut Line Width|Float**: Width of the cut lines in this view.\n\n- **Join Arch|Bool**: If `True`, walls and structures will be fused by material.\n\n- **Line Spacing|Float**: The spacing between lines to use for multiline texts. (v1.0) \n\n\n{{TitleProperty|Drawing view}}\n\n- **Symbol|String|Hidden**: The SVG code defining this symbol.\n\n- **Editable Texts|StringList**: Substitution values for the editable strings in this symbol.\n\n- **Owner|Link**: Feature to which this symbol is attached. (v1.0) \n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe ArchView tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following functions:\n\n \n```python\ndv = FreeCAD.ActiveDocument.addObject('TechDraw::DrawViewArch','TestArch')\ndv.Source = mySectionPlane\nrc = page.addView(dv)\n```\n\n\n {{TechDraw Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw ArchView\n"} {"id": "freecad-docs:wiki/TechDraw_Dimension_Vertical.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_Dimension_Vertical.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_Dimension_Vertical.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "abc8711b9294784be4f26ee38831fc0e3373db310ae338949ef19c1bd6ff4782", "bytes": 216, "tokens": 87, "text": "# TechDraw Dimension Vertical\n1. REDIRECT [TechDraw_VerticalDimension](TechDraw_VerticalDimension.md)\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw Dimension Vertical\n"} {"id": "freecad-docs:wiki/TechDraw_ExtensionCascadeVertDimension.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_ExtensionCascadeVertDimension.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_ExtensionCascadeVertDimension.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ad64ddcc4e9b1b19ea2c457e8bb376083e6486a22e8e596602cfcfd8a26de4eb", "bytes": 1803, "tokens": 569, "text": "---\n GuiCommand:\n Name: TechDraw ExtensionCascadeVertDimension\n MenuLocation: TechDraw , Extensions: Attributes/Modifications , Cascade Vertical Dimensions\n Workbenches: TechDraw_Workbench\n Shortcut: \n Version: 0.20\n SeeAlso: TechDraw_ExtensionCascadeHorizDimension, TechDraw_ExtensionCascadeObliqueDimension\n---\n\n# TechDraw ExtensionCascadeVertDimension\n\n## Description\n\nThe **TechDraw ExtensionCascadeVertDimension** tool evenly spaces vertical dimensions.\n\n \"\" \n*On the right the evenly spaced vertical dimensions*\n\n## Usage\n\n1. Optionally specify the cascade spacing with the \"\" [TechDraw ExtensionSelectLineAttributes](TechDraw_ExtensionSelectLineAttributes.md) tool.\n2. Select two or more vertical dimensions.\n3. The first dimension defines the position. This dimension will not be moved, the other dimensions will be positioned relative to this dimension.\n4. There are several ways to invoke the tool:\n - Press the ** [Cascade Vertical Dimensions](TechDraw_ExtensionCascadeVertDimension.md)** button.\n - Select the **TechDraw → Extensions: Attributes/Modifications → Cascade Vertical Dimensions** option from the menu.\n5. The dimensions are evenly spaced and their dimension texts are centered.\n\n## Notes\n\n- The tool can also be used to center the dimension text of a single dimension.\n\n\n {{TechDraw_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw ExtensionCascadeVertDimension\n"} {"id": "freecad-docs:wiki/TechDraw_ExtensionSelectLineAttributes.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_ExtensionSelectLineAttributes.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_ExtensionSelectLineAttributes.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "0244640aa635f5b9bed06e5fdb03469752355cf2ba3b311b0d63ef1f4088d42f", "bytes": 2402, "tokens": 734, "text": "---\n GuiCommand:\n Name: TechDraw ExtensionSelectLineAttributes\n MenuLocation: TechDraw , Extensions: Attributes/Modifications , Select Line Attributes, Cascade Spacing and Delta Distance\n Workbenches: TechDraw_Workbench\n Shortcut: \n Version: 0.20\n SeeAlso: TechDraw_ExtensionChangeLineAttributes\n---\n\n# TechDraw ExtensionSelectLineAttributes\n\n## Description\n\nThe **TechDraw ExtensionSelectLineAttributes** tool opens a dialog box where you can select the attributes (style, width and color) for new cosmetic lines and centerlines created with the [Extensions tools](TechDraw_Workbench#Extensions.md), and specify the cascade spacing and delta distance. The line attributes are also used by the [TechDraw ExtensionChangeLineAttributes](TechDraw_ExtensionChangeLineAttributes.md) tool.\n\n ![](images/TechDraw_ExtensionSelectLineAttributes_Taskpanel.png ) \n*The Select line attributes task panel*\n\n## Usage\n\n1. There are several ways to invoke the tool:\n - Press the ** [Select Line Attributes, Cascade Spacing and Delta Distance](TechDraw_ExtensionSelectLineAttributes.md)** button.\n - Select the **TechDraw → Extensions: Attributes/Modifications → Select Line Attributes, Cascade Spacing and Delta Distance** option from the menu.\n2. The **Select line attributes** task panel opens.\n3. Optionally change the **Line style**, the **Line width** and the **Line color**.\n4. Optionally change the **Cascade spacing**. The [Cascade Dimensions](TechDraw_Workbench#Attributes_and_modifications.md) tools and the [Create Coordinate Dimensions](TechDraw_Workbench#Dimensions_2.md) tools use this value.\n5. Optionally change the **Delta distance**. The \"\" [TechDraw ExtensionExtendLine](TechDraw_ExtensionExtendLine.md) tool and \"\" [TechDraw ExtensionShortenLine](TechDraw_ExtensionShortenLine.md) tool use this value.\n6. Press the **OK** button.\n\n## Notes\n\n- The specified values will be used in the current FreeCAD session only.\n\n\n {{TechDraw_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw ExtensionSelectLineAttributes\n"} {"id": "freecad-docs:wiki/TechDraw_NewDetail.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_NewDetail.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_NewDetail.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2875fa5e31487adba8ac2a8b67d158710cdf7dbf9beb7329a9b080032e87c3f2", "bytes": 184, "tokens": 77, "text": "# TechDraw NewDetail\n1. REDIRECT [TechDraw_DetailView](TechDraw_DetailView.md)\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw NewDetail\n"} {"id": "freecad-docs:wiki/TechDraw_SectionView.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/TechDraw_SectionView.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/TechDraw_SectionView.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3c266e0d9795a9c661f8124cb7f8536d7febb13e376309d7ddee3af500a4b13e", "bytes": 7414, "tokens": 2328, "text": "---\n GuiCommand:\n Name: TechDraw SectionView\n MenuLocation: TechDraw , TechDraw Views , Insert Section View\n Workbenches: TechDraw_Workbench\n SeeAlso: TechDraw_ComplexSection, TechDraw_View\n---\n\n# TechDraw SectionView\n\n## Description\n\nThe **TechDraw SectionView** tool inserts a cross-section view based on an existing part view.\n\n \"\"\n\"\" \n*Sectioning an already placed view, which shows the internal holes and a hatched cut surface.
\nThe top image shows the ANSI arrow format.
\nThe bottom image shows the ISO arrow format.\n*\n\n## Usage\n\n1. Select a part view in the [3D view](3D_view.md) or [Tree view](Tree_view.md).\n2. There are several ways to invoke the tool:\n - Press the ** [Insert Section View](TechDraw_SectionView.md)** button.\n - Select the **TechDraw → TechDraw Views → Insert Section View** option from the menu.\n3. A task panel opens which will help calculate the various properties. Reasonable values for the view Direction are calculated, but these can be changed.\n\n![](images/TechDraw_Section_Taskview.png ) \n*Taskview to define the sectional cut of a view*\n\n## Properties\n\nSee also: [Property editor](Property_editor.md).\n\nIn the properties of the **Base View** you can change the appearance of the section line.\n\nA Section View, formally a {{Incode|TechDraw::DrawViewSection}} object, is derived from a [Part View](TechDraw_View#Properties_Part_View.md), formally a {{Incode|TechDraw::DrawViewPart}} object, and inherits all its properties. It also has the following additional properties:\n\n### Data\n\n\n{{TitleProperty|Appearance}}\n\n- **Section Line Stretch|FloatConstraint**: Adjusts the length of the section line. {{Value|1.0}} is normal length, {{Value|1.1}} would be 10% longer, {{Value|0.9}} would be 10% shorter. (v1.0) \n\n\n{{TitleProperty|Cut Operation}}\n\n- **Fuse Before Cut|Bool**: Fuse the source shapes before performing the section cut.\n\n- **Trim After Cut|Bool**: Additionally trim the resulting shape after the section cut to remove any unwanted pieces. (v0.21) \n\n- **Use Previous Cut|Bool**Use the cut shape from the base view instead of the original object. (v1.0) \n\n\n{{TitleProperty|Cut Surface Format}}\n\n- **Cut Surface Display|Enumeration**: Appearance of the cut surface. Options:\n\n - \n {{Value|Hide}}\n \n : Hides the cut surface, only the outline will be displayed.\n\n - \n {{Value|Color}}\n \n : Colors the cut surface using the setting of **Cut Surface Color** in the [TechDraw preferences](TechDraw_Preferences.md).\n\n - \n {{Value|SvgHatch}}\n \n : Hatches the section cut using a [hatch](TechDraw_Hatch.md)\n\n - \n {{Value|PatHatch}}\n \n : Hatches the section cut using a [geometric hatch](TechDraw_GeometricHatch.md)\n\n- **File Hatch Pattern|File**: Full path to SVG hatch pattern file.\n\n- **File Geom Pattern|File**: Full path to PAT pattern file.\n\n- **Svg Included|FileIncluded**: Full path to the included SVG hatch pattern file.\n\n- **Pat Included|FileIncluded**: Full path to the included PAT pattern file.\n\n- **Name Geom Pattern|String**: Name of the PAT pattern to use.\n\n- **Hatch Scale|Float**: Hatch pattern size adjustment.\n\n- **Hatch Rotation|Float**: Rotation of hatch pattern in degrees counter-clockwise. (v0.21) \n\n- **Hatch Offset|Vector|Hidden**: Hatch pattern offset. (v0.21) \n\n\n{{TitleProperty|Section}}\n\n- **Section Symbol|String**: The identifier for this section.\n\n- **Base View|Link**: The view on which this section is based.\n\n- **Section Normal|Vector**: A vector describing the direction normal to the cutting plane.\n\n- **Section Origin|Vector**: A vector describing a point on the cutting plane. Typically the centroid of the original part.\n\n- **Section Direction|Enumeration**: The direction in the Base View for this section. Options: {{Value|Aligned}}, {{Value|Right}}, {{Value|Left}}, {{Value|Up}} or {{Value|Down}}.\n\n### View\n\n\n{{TitleProperty|Cut Surface}}\n\n- **Cut Surface Color|Color**: Solid color for surface highlight. Used if **Cut Surface Display** is set to {{Value|Color}}.\n\n- **Show Cut Surface|Bool|Hidden**: Show/hide the cut surface.\n\n\n{{TitleProperty|Surface Hatch}}\n\n- **Geom Hatch Color|Color**: The color of the Geometric hath pattern.\n\n- **Hatch Color|Color**: The color of the Svg hatch pattern.\n\n- **Hatch Cut Surface|Bool|Hidden**: Hatch the cut surface.\n\n- **Weight Pattern|Float**: Line weight of the Geometric hatch pattern.\n\n## Notes\n\n- **Section Line Format**: two section line formats are supported (as depicted above) and controlled by the Preference setting \\\"Section Line Standard\\\" on the Annotation tab. The {{Value|ANSI}} option uses \\\"pulling arrows\\\" (known as the \\\"traditional format\\\" in some areas) and the {{Value|ISO}} option uses \\\"pushing arrows\\\" (also known as the \\\"reference arrow format\\\").\n- **Fuse Before Cut**: the section operation sometimes fails to cut the source shapes. If **Fuse Before Cut** is true, the source shapes are merged into a single shape before the section operation is attempted. If you encounter problems with the section operation, try flipping this value.\n- **Trim After Cut**: the section cut operation sometimes leaves behind a portion of the source shape. If **Trim After Cut** is true, an additional cut operation is performed on the result of the first cut which should remove any unwanted pieces.\n- **Cut Surface Display**: the cut surface can be hidden, painted in a solid color, hatched using an Svg pattern (default) or hatched using a PAT pattern. See [Hatching](TechDraw_Hatching.md).\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nA SectionView can be created with [macros](Macros.md) and from the [Python](Python.md) console by using the following functions:\n\n \n```python\ndoc = FreeCAD.ActiveDocument\nbox = doc.Box\npage = doc.Page\n\nview = doc.addObject(\"TechDraw::DrawViewPart\", \"View\")\npage.addView(view)\nview.Source = box\nview.Direction = (0, 0, 1)\n\nsection = doc.addObject(\"TechDraw::DrawViewSection\", \"Section\")\npage.addView(section)\nsection.Source = box\nsection.BaseView = view\nsection.Direction = (0, 1, 0)\nsection.SectionNormal = (-1, 0, 0)\n\ndoc.recompute()\n```\n\n## Examples\n\nFor some more information about section views and some use cases, have a look at: [TechDraw section examples](TechDraw_Section_Examples.md).\n\n \"\" \"\" \"\" \"\" \"\" \"\" \n\n\n {{TechDraw_Tools_navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](TechDraw_Workbench.md) > TechDraw SectionView\n"} {"id": "freecad-docs:wiki/Video_tutorials_for_architectural_design.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Video_tutorials_for_architectural_design.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Video_tutorials_for_architectural_design.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "289fe2c7cc107c733bdaec39f2188b413d3d65877bf711eccdde0fa21dda1409", "bytes": 8564, "tokens": 2935, "text": "# Video tutorials for architectural design\n**Please pay attention to the version of FreeCAD used in the tutorial. If a tutorial uses an older version of the program, the general modelling process may still work but some tools may have changed in newer releases. Do not add videos made with version 0.16 or older, as these releases are considered obsolete.**\n\n## Introduction\n\nThe tutorials listed here are those that deal with designing rooms, houses, and other buildings which interesting for architects and civil engineers. For other topics, see the general page [video tutorials](video_tutorials.md).\n\nVisit [tutorials](tutorials.md) for high quality written tutorials. A complete, unsorted list of tutorials can be found in [:Category:Tutorials](:Category_Tutorials.md).\n\n## Architectural design \n\nVideos that go through modeling of rooms, houses, office buildings, and similar structures, and drawing floor plans, using workbenches such as \"\" [Draft](Draft_Workbench.md) and \"\" [BIM](BIM_Workbench.md).\n\n- [Yorik van Havre playlists](https://www.youtube.com/user/yorikvanhavre/playlists): the [BIM Workbench](BIM_Workbench.md) main developer has various lists on FreeCAD for building modeling as well as general architecture.\n - [Presentation of FreeCAD\\'s Arch Workbench](https://www.youtube.com/watch?v=lTDOeHapv_E): FreeCAD 0.16, presentation for #ODC2016PN.\n - [BIM with FreeCAD - Introduction](https://www.youtube.com/watch?v=rkWOFQ2fGZQ): general introduction to FreeCAD 0.17.\n - [BIM with FreeCAD](https://www.youtube.com/watch?v=QhDMhYvxPO4&list=PLmKdGVtV5Vnt2cj4IZIv9FM39QHaE1ZaU): FreeCAD 0.17 to 0.19, general videos on BIM and and Arch Workbench, including setup, building walls, windows, using 2D objects, and expressions.\n - [Barcelona pavilion](https://www.youtube.com/watch?v=N9K9YJxroc4&list=PLmKdGVtV5VnuE5U75CEORkjlVK_nzQQUh): FreeCAD 0.18 and 0.19, a series of 17 videos that describes the modeling of the \\\"Barcelona Pavilion\\\" (or \\\"German Pavilion\\\"), a building in Barcelona designed by Ludwig Mies van der Rohe and Lilly Reich in 1929. The videos demonstrate importing geometry from a DXF file, then go on to draw the walls, the windows, the glass panels, the structural elements and roofs, the floor tiles, the terrain, the footings and the stairs. Then it shows how to export the model to IFC, how to create 2D projections in TechDraw, how to work with quantities and schedules, and finally how to create a rendered view of the project in Blender.\n\n- [Arch WB Experience: New Workflow](https://forum.freecadweb.org/viewtopic.php?f=36&t=44475): a series of videos by jpg87, hosted in his own website, which teach users to model walls, roofs, and windows and doors in different positions, with the help of [sketches](sketch.md).\n\n- [Regis Nde Tene\\'s playlists](https://www.youtube.com/user/RegisBBNT/playlists): various videos on architectural modelling using Blender and FreeCAD, by Regis Nde Tene, in English and French.\n - [FreeCAD Tuts](https://www.youtube.com/watch?v=dVY0nz1_vsc&list=PLDd21g-eSHwkkxVOfVmR8ObpPN5QbL7ye): a series of 16 videos covering a wide range of aspects of Architecture modeling including 2D plan creation, 3D modelling, using constraints, annotations, Arch spaces, rebars, exporting to PDFs, doing curtain walls, using an axis system, creating a multilayer wall, creating a wall cladding, and designing a cabinet.\n - [Freecad tuto French](https://www.youtube.com/watch?v=f2hN1yw1Mmc&list=PLDd21g-eSHwm9RVdLGf_ONaRxtdeQJSV_): tutorial in French.\n - [Elemental - Quinta Monroy](https://www.youtube.com/watch?v=eilLbM64-dc&list=PLDd21g-eSHwnAYyutuKhrPY51skaBhrVU): FreeCAD 0.17, a series of 35 videos that completely model the \\\"Quinta Monroy\\\" by Elemental. It starts by importing various DXF files for floor and elevation views that can be used as reference, and then proceeds to model the 3D objects such as walls, concrete structures, roofs, windows, and stairs. The series has two types of videos: long videos that show the modelling process in detail, and shorter videos that speed through the process to show the general steps taken in the long video.\n - [Blender & Freecad Arch Workflow](https://www.youtube.com/watch?v=xOIdc6nTMT4&list=PLDd21g-eSHwn41rhRP-hidQhErgXoXZQ1): a series of 10 videos showing how to create a building in Blender, and exporting the model to FreeCAD.\n\n- [UH Studio Design Academy playlists](https://www.youtube.com/channel/UC4fyqGDhEQq_L4nzSpNMoUA/playlists): many videos on architectural design using Blender and FreeCAD, by UH Studio Design Academy.\n - [Freecad](https://www.youtube.com/watch?v=9EzxiwjKzTQ&list=PLJThqQUeIsPTw-SQeY595Kpz_xQeZxz4o): FreeCAD 0.18, a series of 7 videos that present various aspects of architectural modeling, parametric building massing, introducing FreeCAD to architects and Revit users, using sketches and parametric relationships, and comparisons with grasshopper and Catia.\n - Introduction to FreeCAD for architects and Revit users, [Part 1](https://www.youtube.com/watch?v=tIqW79KsbdU&list=PLJThqQUeIsPTw-SQeY595Kpz_xQeZxz4o&index=6), [Part 2](https://www.youtube.com/watch?v=hcGeyXdBSs4&list=PLJThqQUeIsPTw-SQeY595Kpz_xQeZxz4o&index=2)\n\n- [Eklavya Self Learning Tutorials playlists](https://www.youtube.com/user/cnirbhay/playlists): various videos on using FreeCAD, particularly focusing on architectural and civil engineering usage, by Eklavya Self Learning Tutorials.\n - [Architectural BIM Modeling Course Using FreeCAD](https://www.youtube.com/watch?v=TyhRc1z616E&list=PL1Fv0Kg44dc3oWoFMEBXT5xjvk9AsWnLW): FreeCAD 0.16, a series of 11 videos showing how to model a building including creating a slab, external walls, doors, windows, internal walls, floors, roofs, adding colors and materials, and doing rendering.\n - [FreeCAD Tutorials](https://www.youtube.com/watch?v=wAJe1R5NDGw&list=PL1Fv0Kg44dc0rUv54ovSRMNyp-jtXlx0e): FreeCAD 0.16, a series of 18 videos dealing with various architectural topics like dimensioning structures, creating rebars, analyzing structures, interoperability between FreeCAD and Blender, and Revit, creating tubular structures, creating a curved terrain, using geographical data, and creating 2D architectural plans.\n - [FreeCAD FEM/Civil/Structural/Arch Tutorial-1-An Introduction](https://www.youtube.com/watch?v=wAJe1R5NDGw): FreeCAD 0.16, and introduction that builds a simple structure of pillars and beams, and analyzes them with the [FEM Workbench](FEM_Workbench.md).\n\n- [An Arch project with open source](https://www.youtube.com/watch?v=KaojKTwXMs8): a house project and energy analysis with FreeCAD, Blender 3D, and VI Suite, by Green Hub (sergiobini), [Part 1](https://www.youtube.com/watch?v=KaojKTwXMs8), [Part 2](https://www.youtube.com/watch?v=m8bQFKL5bYQ).\n\n- [FreeCAD for Architecture playlists](https://www.youtube.com/channel/UCAqm-txbiSCehNJ2qq_pJeQ/playlists): many videos for architectural modeling in Indonesian language, by FreeCAD for Architecture.\n - [Complete house project tutorial for architect \\'from zero to hero\\' using FreeCAD!](https://www.youtube.com/watch?v=RcX0-IArnzo&list=PLwA6cJhCSx1M8BGm9eZ_hZFvz48u8YCFl): a series of 24 videos showing many steps like drawing the floor plan, windows, doors, walls, furniture, text annotations, and dimensions, modelling the roof, draw a fence, prepare the model for exporting to Blender, and more.\n - [tips and trick for better and fastest workflow in FreeCAD!](https://www.youtube.com/watch?v=m_f7lr6AKNk&list=PLwA6cJhCSx1P1erikDHTa6C9t2CweQaz-): a series of 8 videos with various tricks to use FreeCAD in a better way.\n\n- [Peter Böttcher playlists](https://www.youtube.com/channel/UCJ-BL4wcOD1InrlbJsC02AQ/playlists): various high quality BIM related videos in German by Prof. Dr. Peter Böttcher.\n - [Grundmodell mit FreeCAD und ARCH](https://www.youtube.com/watch?v=Qe-vXRtKql4&list=PLNv9lsSmVr-iDNhHqJ1u8aZUImYIc8bB8): first part of a series of two videos with step-by-step instructions to create a simple model. General introduction to FreeCAD, axis systems and BuildingParts.\n - [Fachmodell mit FreeCAD und ARCH](https://www.youtube.com/watch?v=iarSNPBKkfo&list=PLNv9lsSmVr-iDNhHqJ1u8aZUImYIc8bB8): second part of the series. The building of the actual model: a garage.\n\n\n---\n⏵ [documentation index](../README.md) > [Tutorials](Category_Tutorials.md) > Video tutorials for architectural design\n"} {"id": "freecad-docs:wiki/Visibility.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Visibility.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Visibility.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "73089103662a8356446e91d2f03bfe294465b9a5a1fd1140940bde07bf2e2c48", "bytes": 149, "tokens": 62, "text": "# Visibility\n1. REDIRECT [Std_ToggleVisibility](Std_ToggleVisibility.md)\\ Visibility\n"} {"id": "freecad-docs:wiki/Web_BrowserZoomIn.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/Web_BrowserZoomIn.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/Web_BrowserZoomIn.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "615f5b069653852caf4206d99cfea863c9e78c6f68d2909f0bb217b90939e261", "bytes": 543, "tokens": 220, "text": "---\n GuiCommand:\n Name: Web BrowserZoomIn\n MenuLocation: \n Workbenches: Web_Workbench, Start_Workbench\n SeeAlso: \n---\n\n# Web BrowserZoomIn\n\n## Description\n\nUse the \"\" **Web BrowserZoomIn** command to zoom in on the current web page.\n\n## Usage\n\n1. Press the ** [Zoom in](Web_BrowserZoomIn.md)** button.\n\n\n {{Web Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [Web](Web_Workbench.md) > Web BrowserZoomIn\n"} {"id": "freecad-docs:wiki/translations/en/Arch_Floor.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Arch_Floor.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Arch_Floor.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "993d71f847c5e81fb49470a04f2fb04a818d05fe02fbdaf9dacee53bdf39ba64", "bytes": 2804, "tokens": 934, "text": "---\n GuiCommand:\n Name: Arch Floor\n MenuLocation: 3D/BIM , Level\n Workbenches: BIM_Workbench\n Shortcut: **L** **V**\n SeeAlso: \n---\n\n# Arch Floor/en\n\n## Description\n\nThe **Arch Floor** tool is a special type of FreeCAD group object that has a couple of additional properties particularly suited for building floors. Particularly, they have a height property, that its children objects ([walls](Arch_Wall.md) and [structures](Arch_Structure.md)) can use to set their own height automatically. They are mostly used to organize your model.\n\nAs of (v0.18) the Arch Floor is derived entirely from the [Arch BuildingPart](Arch_BuildingPart.md) object, which is a general container to organize a building model not limited to floors or storeys. Older Floor objects can be converted to the new type by right clicking on them and choosing `Convert to BuildingPart`.\n\n## Usage\n\n1. Optionally, select one or more objects to be included in your new floor.\n2. Invoke the Arch Floor command several ways:\n - Pressing the ** [Floor](Arch_Floor.md)** button on the toolbar.\n - Using the **L** then **V** keyboard keys.\n - Using the **3D/BIM → Floor** entry from the top menu.\n\n## Options\n\n- After creating a floor, you can add more objects to it by drag and dropping them in the Tree View or by using the ** [Arch Add](Arch_Add.md)** tool.\n- You can remove objects from a floor by drag and dropping them out of it the Tree View or by using the ** [Arch Remove](Arch_Remove.md)** tool.\n\n## Properties\n\nAn Arch Floor object shares all properties from an [Arch BuildingPart](Arch_BuildingPart.md), with the **Ifc Type** set to `\"Building Storey\"`.\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 Floor tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function:\n\n\n```python\nFloor = makeFloor(objectslist=None, baseobj=None, name=\"Floor\")\n```\n\n- Creates a `Floor` object from `objectslist`, which is a list of objects.\n\nExample:\n\n\n```python\nimport FreeCAD, Draft, Arch\n\np1 = FreeCAD.Vector(0, 0, 0)\np2 = FreeCAD.Vector(2000, 0, 0)\nbaseline = Draft.makeLine(p1, p2)\nbaseline2 = Draft.makeLine(p1, -1*p2)\n\nWall1 = Arch.makeWall(baseline, length=None, width=150, height=2000)\nWall2 = Arch.makeWall(baseline2, length=None, width=150, height=1800)\nFreeCAD.ActiveDocument.recompute()\n\nFloor = Arch.makeFloor([Wall1, Wall2])\n\nBuilding = Arch.makeBuilding([Floor])\nSite = Arch.makeSite(Building)\nFreeCAD.ActiveDocument.recompute() \n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch Floor/en\n"} {"id": "freecad-docs:wiki/translations/en/Arch_IFC.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Arch_IFC.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Arch_IFC.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "139d7e2008943bfc151c02b1d8d27cf1f3342eeb55cb90793296a0ecf3beb898", "bytes": 8198, "tokens": 2439, "text": "# Arch IFC/en\n## Description\n\nThe \"\" [BIM Workbench](BIM_Workbench.md) supports [Industry Foundation Classes (IFC)](http://en.wikipedia.org/wiki/Industry_Foundation_Classes) files natively, and also provides an importer and exporter. The IFC format is a continuously growing format to interchange data among [BIM](http://en.wikipedia.org/wiki/Building_Information_Modeling) applications, used in architecture and engineering.\n\nRead more about handling IFC files in FreeCAD on the [NativeIFC](NativeIFC.md) page.\n\n#### IfcOpenShell\n\nAll the IFC functionality depends on the [IfcOpenShell](IfcOpenShell.md) library, which is bundled in some distributions of FreeCAD. An easy way to check if IfcOpenShell is available is to enter the following in the [Python console](Python_console.md):\n\n\n```python\nimport ifcopenshell\n```\n\nIf no error message appears, IfcOpenShell is installed, and you may proceed with [opening](Std_Open.md) or [importing](Std_Import.md) IFC files. Otherwise, you will need to install IfcOpenShell yourself; read the [IfcOpenShell](IfcOpenShell.md) page to learn more about this process.\n\n\n**Note:**\n\nThe **[ [BIM Setup](BIM_Setup.md)** tool will look for IfcOpenShell too, and issue a notification if it is not installed.\n\n## Opening and Importing \n\nStarting from version 1.0, FreeCAD opens and imports IFC files natively. Read more on the [NativeIFC](NativeIFC.md) page.\n\n### Older importers \n\n#### The Arch importer \n\nThe original IFC importer from the Arch Workbench has been disabled in FreeCAD version 1.0, but is still available from Python:\n\n\n```python\nfrom importers import importIFC\nimportIFC.open(\"C:\\\\Path\\\\To\\\\My\\\\File.ifc\")\n```\n\nAll [IfcProduct](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifckernel/lexical/ifcproduct.htm)-based entities from IFC2x3 or IFC4 files will be imported into the FreeCAD document. The IFC preferences settings allow you to set how the IFC objects are imported:\n\n- **full parametric Arch objects**, the geometry will, as much as possible, be editable in FreeCAD\n- **non-parametric Arch objects**, objects will carry IFC information and properties but will not be editable\n- **non-parametric Part shapes**, the geometry will be faithfully rendered but IFC information will be discarded\n- **one Part shape per floor**, one all-in-one object, just for reference\n\nEach of these types loses some information over the previous one, but is lighter on resources, which allows to open bigger files. A last type allows to discard entirely the importing of Arch objects, which is useful for structural analytic models.\n\nTypically, if you try to open a large file and FreeCAD takes too long to import it, try with a lower import mode.\n\nIfcOpenShell supports all IFC2x3 and IFC4 entities (IFC4-add1 and IFC4-add2 are being implemented in v0.6 and might be available by the time you read this) but not all of them can be converted to [BIM](BIM_Workbench.md) objects, those that can\\'t will be imported as simple [Part](Part_Workbench.md) shapes. The IFC importer starts by importing all IFC entities derived from [IfcProduct](http://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ifckernel/lexical/ifcproduct.htm), that is, basically, all the objects that compose a building, such as walls or windows or pipes. All other entities needed by one of these objects, such as profiles of extrusion, or components of boolean operations, will be imported as required.\n\nIf using an import mode that uses Arch objects, being parametric or not, all objects will carry the full set of [IfcProperties](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcpropertyresource/lexical/ifcproperty.htm) attached to each object, grouped by Property Set.\n\nBuilding structures such as Sites, Buildings and Storeys are also faithfully imported and the structure is correctly recreated in FreeCAD. Group structures (using IfcGroups) are also imported and rendered in FreeCAD, and can be combined with building structures, for ex. having groups inside storeys or storeys inside groups.\n\n[IfcAnnotation](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcproductextension/lexical/ifcannotation.htm) objects are also imported, as well as linear and curve-based [IfcStructuralItem](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcstructuralanalysisdomain/lexical/ifcstructuralitem.htm)-based entities.\n\nQuantities specified in the IFC file are **NOT** imported. However, since the geometry is fully recreated in FreeCAD, most of the quantities such as length, area, etc. are easily obtainable for each object.\n\nEnabling the **show debug messages** in the IFC preferences settings will print a report indicating if any object from the IFC file failed to import.\n\n**Note**: The BIM Workbench features an [IFC explorer](BIM_IfcExplorer.md) tool that allows you to open an IFC file in fast, text-only mode, and import only the parts you wish.\n\n#### The legacy importer \n\nIn the past, the Arch Workbench used to feature a simpler IFC importer that didn\\'t depend on IfcOpenShell. This legacy module is still included in the source code and usable from Python but it is not recommended at all; it will only be able to import a very small subset of IFC objects, and should be considered completely obsolete.\n\nThe legacy importer can be used from Python:\n\n\n```python\nfrom importers import importIFClegacy\nimportIFClegacy.open(\"C:\\\\Path\\\\To\\\\My\\\\File.ifc\")\n```\n\n## Exporting\n\nExporting to IFC files will export all the selected objects and their descendants. All Arch/BIM objects are supported, as well as other objects created in other workbenches. The only not fully supported objects, at the moment, are **[ [PartDesign Bodies](PartDesign_Body.md)**, **[ [Std Parts](Std_Part.md)**, and new structures such as **[ [App Links](Std_LinkMake.md)** and **[ LinkGroups**, so you will need a bit of testing if using them. [Arch References](Arch_Reference.md) will currently export as `IfcBuildingElementProxies`.\n\nTo export a whole site or building or a whole floor or a group containing other objects, it is only needed to select that building or floor or group. Arch objects will be exported with the type set in their \\\"IFC Type\\\" property. Their [IfcProperties](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcpropertyresource/lexical/ifcproperty.htm) are exported as well, and if these objects have an IFC UID from a previous import, the same UID will be kept at export. Objects that are not Arch objects are exported as [IfcBuildingElementProxy](http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifcsharedbldgelements/lexical/ifcbuildingelementproxy.htm).\n\nIFC files are exported as IFC2x3 or IFC4 depending on your version of IfcOpenShell, which can be compiled with any of the IFC schemas. If using IfcOpenShell v0.6 or higher, the IFC version specified in the Arch preferences will be used.\n\nIf the shape of exported objects is based on an extrusion or a boolean operation, the operation and components will be correctly exported to IFC. If not, the object\\'s shape is exported as [IfcFacetedBrep](http://www.buildingsmart-tech.org/ifc/IFC4x1/html/schema/ifcgeometricmodelresource/lexical/ifcfacetedbrep.htm). If the shape contains curves, these will be triangulated. However, IfcOpenShell v0.5 or above feature a serializer, which must be enabled in the Import/Export → IFC preferences. If enabled, this serializer is able to export very complex curved objects such as those based on NURBS, and thus avoid triangulated faces. At the time of writing, though, few other BIM applications support IFC NURBS objects, so a bit of testing is advised.\n\n## Further information \n\n- [IfcOpenShell](IfcOpenShell.md), more information on installing this library.\n\n\n---\n⏵ [documentation index](../README.md) > [File_Formats](Category_File_Formats.md) > [BIM](Category_BIM.md) > Arch IFC/en\n"} {"id": "freecad-docs:wiki/translations/en/Arch_RebarTools.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Arch_RebarTools.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Arch_RebarTools.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "8d99f480cd601730ce41ea9cc72c65e003a5b24b7895034e603dcea3cf0eeb88", "bytes": 174, "tokens": 79, "text": "# Arch RebarTools/en\n1. REDIRECT [BIM_Workbench/en#Arch_RebarTools](BIM_Workbench/en#Arch_RebarTools.md)\n\n\n---\n⏵ [documentation index](../README.md) > Arch RebarTools/en\n"} {"id": "freecad-docs:wiki/translations/en/Arch_Rebar_Footing_Reinforcement.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Arch_Rebar_Footing_Reinforcement.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Arch_Rebar_Footing_Reinforcement.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "ab7d04aefb9e7299282e9eb88b00fa1ba98174ab2e1d9df3ac33e369ff1b5bdd", "bytes": 204, "tokens": 79, "text": "# Arch Rebar Footing Reinforcement/en\n1. REDIRECT [Reinforcement_FootingRebars/en](Reinforcement_FootingRebars/en.md)\n\n\n---\n⏵ [documentation index](../README.md) > Arch Rebar Footing Reinforcement/en\n"} {"id": "freecad-docs:wiki/translations/en/Assembly3_ConstraintAlignment.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Assembly3_ConstraintAlignment.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Assembly3_ConstraintAlignment.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "2805031a18fcfc718d7877d81f28d61e962dba3ce05560a393ff79b8a09577d6", "bytes": 1376, "tokens": 415, "text": "---\n GuiCommand:\n Name: Assembly3 ConstraintAlignment\n Icon: Assembly_ConstraintAlignment.svg\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ConstraintAlignment/en\n\n## Description\n\nThis tool links two or more objects of an assembly and matches their orientations. The selected elements of each object or more precisely their implicit coordinate systems (ICSs) are used to position one object in relation 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 the x-y-planes of all ICSs are coplanar and the z-axes point in the same direction.\n\nThe offset of their z-axes and the angle between their x-axes (and y-axes as well) are not defined. Related to the first object the following objects can still move along the x- and y-direction and spin around the z-axis. This is leaving 3 degrees of freedom (DOFs) for each link unconstrained.\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 ** [Alignment](Assembly3_ConstraintAlignment.md)** button.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 ConstraintAlignment/en\n"} {"id": "freecad-docs:wiki/translations/en/Assembly3_ImportMultiDocument.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Assembly3_ImportMultiDocument.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Assembly3_ImportMultiDocument.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "06ced623c478c560fd774f5206ddee5e4ef050836d3936e67e00a01fdcf936a1", "bytes": 1724, "tokens": 571, "text": "---\n GuiCommand:\n Name: Assembly3 ImportMultiDocument\n Icon: Assembly_Import.svg\n MenuLocation: Assembly3 , Import from STEP , Import as multi-document\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 ImportMultiDocument/en\n\n## Description\n\nThe \"\" [Import as multi-document](Assembly3_ImportMultiDocument.md) command opens a file browser window to search and select STEP files.\n\nSTEP assemblies are imported into separate documents.\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 as multi-document](Assembly3_ImportMultiDocument.md)** button.\n - Press the down arrow of the ** '''Import from STEP'''** button and select the ** Import as multi-document** option from the dropdown.\n - Select the **Assembly3 → Import from STEP → Import as multi-document** option from the menu.\n - Select the **Assembly → Import from STEP → Import as multi-document** 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 ImportMultiDocument/en\n"} {"id": "freecad-docs:wiki/translations/en/Assembly3_SmartRecompute.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Assembly3_SmartRecompute.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Assembly3_SmartRecompute.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "aa44366823d134c2d75bd214bd733ee02da1f1d05e37cd356021cf6b0c8af194", "bytes": 848, "tokens": 303, "text": "---\n GuiCommand:\n Name: Assembly3 SmartRecompute\n Icon: Assembly_SmartRecompute.svg‎‎\n MenuLocation: Assembly3 , Smart recompute\n Workbenches: Assembly3_Workbench\n---\n\n# Assembly3 SmartRecompute/en\n\n## Description\n\nThe \"\" [Smart recompute](Assembly3_SmartRecompute.md) command does\\...\n\n## Usage\n\n1. Activate the \"\" **Smart recompute** command using one of the following:\n - The ** [Smart recompute](Assembly3_SmartRecompute.md)** button.\n - The **Assembly3 → Smart recompute** menu option.\n\n\n---\n⏵ [documentation index](../README.md) > Assembly3 SmartRecompute/en\n"} {"id": "freecad-docs:wiki/translations/en/Books.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Books.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Books.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a0f5c328cd4902e1f5dd57737eaf4fea805bf7cb890b7d86bec640cd10ac366d", "bytes": 5876, "tokens": 1545, "text": "# Books/en\nThis page lists the books about FreeCAD we know of:\n\n## FreeCAD Beginner's Starter Kit \n\nBy Aleksander Sadowski, published May 2023, ebook/paperback\n\n\"\"\n\nFreeCAD is commonly known for its steep learning curve which stems from an overwhelming amount of possibilities available to the beginner. This book simplifies the use of FreeCAD for you by equipping you with an easy workflow, while giving context to the functions you need. You will learn to create fun projects, design helpful gadgets for your house or even get on an adventure and design your own products. This book strives to condense the knowledge from beginner courses into a tangible guide that anyone can pick up and learn how to create 3D designs with FreeCAD. You will overcome your frustration with breaking models or not knowing how to recover them and make you confident enough to be able to create your own designs from beginning to end - from the first idea to the 3D printable model.\n\nYou will learn the basic concepts of solid 3D modeling and how to apply those using FreeCAD. You will then build an entire project from scratch and turn an idea to individual 3D CAD parts with Part Design and Sketcher, assemble all parts digitally with A2Plus, prepare and export the 3D CAD models for 3D printing. You will also learn how to share your models using fcprint.\n\nBy the end of this book, you will be able to design your own little 3D printable gadgets that you have dreamt of and share those with your friends and the entire world.\n\n****\n\n\n## FreeCAD for Makers \n\nBy Jo Hinchliffe, published September 2022, free ebook\n\n\"\"\n\nFreeCAD is the number one free software 3D design program, and this PDF guide is the best way to get started with it. We'll take you from absolute beginnner to advanced user, going from the basics of drawing a line and making it 3D all the way to parametric design, importing objects from photographs, designing for sheet metal, and loads more.\n\nBecause FreeCAD is free software, its users can add to it, writing extensions to the software to suit their needs. These add-ons, known as workbenches, cover a range of uses, including PCB design, pipes, timber-framing, architectural design... the list of practical use cases goes on and on. So, whatever you're interested in building, you'll find a FreeCAD workbench for it.\n\n****\n\n\n## FreeCAD for architectural drawing \n\nBy Allan Brito, published August 2020, ebook/paperback\n\n\"\"\n\nDo you want to start using a free and open-source software to work in your CAD related projects? Meet FreeCAD and their incredible array of options to create both technical drawings and 3D models for architecture, engineering, and more.\n\nIn this book, you will learn how to use FreeCAD to create traditional technical drawings for architecture. As an example of project development, you will learn how to draw a full featured floor plan using FreeCAD. We will add to that floor plan all traditional elements from an architectural drawing like furniture, dimension lines, text annotations, and much more.\n\nIn the final chapters, we can take this floor plan design and export it using either the DXF format or as a PDF. You will be able to add the floor plan to page layout for print featuring a title block from a template in FreeCAD.\n\nYou don\\'t need any previous experiences with FreeCAD, since we will start from the beginning. From the user interface basics to drawing a floor plan!\n\n****\n\n\n## FreeCAD for Inventors \n\nBy Brad Collette, published September 2018, ebook/paperback\n\n\"\"\n\nThis book introduces novice and intermediate users to the most frequently used tools and techniques in FreeCAD. Part one introduces new users to FreeCAD concepts and User Interface. Part two teaches various modeling techniques with a handful of examples. Part three uses the examples to explore FreeCAD\\'s ability to generate: Technical Drawings, Gcode for CNC machines, Ray-traced images and more.\n\n****\n\n\n## FreeCAD How-to \n\nBy Daniel Falck, Brad Collette, published September 2012, ebook/paperback\n\n\"\"\n\nFreeCAD is a general purpose platform for CAD development. It can be extended to use different workbenches to solve different problems. Targeted squarely at the engineering community, FreeCAD is an open source design application built to be extended. Python, the powerful scripting language, is woven deeply into FreeCAD's DNA and gives users unprecedented power to automate and invent.\n\n\\\"FreeCAD \\[How-to\\]\\\" is a lean, fast tour of FreeCAD\\'s major workbenches and design philosophy. The reader will get a hands-on introduction to several modeling techniques and learn how Python makes macro automation and design possible.\n\nFreeCAD allows users to design in a variety of ways; from drawing 2D designs as lines and circles to combining primitive solids into complex 3D shapes. Objects can even be created or modified by code you write in Python. FreeCAD even allows power users to extend the application itself with new dialogs, panels, and scripts. This book will not only show you how to get started using FreeCAD in a traditional GUI mode, but will teach you how to harness its powerful scripting language for more power.\n\n****\n\n\n---\n⏵ [documentation index](../README.md) > Books/en\n"} {"id": "freecad-docs:wiki/translations/en/CAM_Fixture.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/CAM_Fixture.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/CAM_Fixture.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6d426d05f4b00a88ba39eb855cfa496e699083c5bf61efeea8a4ceea07c842ae", "bytes": 1408, "tokens": 465, "text": "---\n GuiCommand:\n Name: CAM Fixture\n MenuLocation: CAM , Supplemental Commands , Fixture\n Workbenches: CAM_Workbench\n---\n\n# CAM Fixture/en\n\n## Description\n\nThe tool \"\" [Fixture](CAM_Fixture.md) sets the Work Offset Coordinate Fixture of the machine CNC controller.\n\nTarget Work Offset Coordinates typically include: Fixtures G53 to G59. The G-code is simply the Fixture (G53, G54, etc\\...). The coordinate offset fixtures represent:\n\n- G53 → Machine coordinate system.\n- G54 → Scratchpad coordinate system.\n- G55 to G59.9 → Coordinate fixtures allowing work offsets, relative to Homing switches located on the CNC machine, to be used.\n\nThe G59 Fixture is used to expand available fixtures. The degree of expansion implemented is CNC machine specific, and this command allows provides for G59.1 to G59.9.\n\n## Usage\n\n1. Press the ** [Fixture](CAM_Fixture.md)** button or use the **P** then **F** keyboard shortcut.\n2. Select the desired Work Offset Fixture from the drop-menu.\n\n## Properties\n\n- **Fixture**: Sets the current fixture point\n\n- **Active**: Defines if this command is active or not when inserted into a compound\n\n## Notes\n\n## Limitations\n\n## Scripting\n\n\n{{CAM_Tools_navi\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > [CAM](CAM_Workbench.md) > CAM Fixture/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_FCGear.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_FCGear.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_FCGear.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f162f68ba15828eaaf78b33ba4f27c30503b3f82697a356437428c0956704dca", "bytes": 1053, "tokens": 490, "text": "# Category:FCGear/en\nAll relevant pages to the [FCGear workbench](FCGear_Workbench.md) (an [external workbench](external_workbenches.md))\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [FCGear BevelGear/en](FCGear_BevelGear/en.md) | [FCGear CrownGear/en](FCGear_CrownGear/en.md) | [FCGear CycloidGear/en](FCGear_CycloidGear/en.md) |\n| [FCGear CycloidRack/en](FCGear_CycloidRack/en.md) | [FCGear GearConnector/en](FCGear_GearConnector/en.md) | [FCGear HypoCycloidGear/en](FCGear_HypoCycloidGear/en.md) |\n| [FCGear InternalInvoluteGear/en](FCGear_InternalInvoluteGear/en.md) | [FCGear InvoluteGear/en](FCGear_InvoluteGear/en.md) | [FCGear InvoluteRack/en](FCGear_InvoluteRack/en.md) |\n| [FCGear LanternGear/en](FCGear_LanternGear/en.md) | [FCGear TimingGear/en](FCGear_TimingGear/en.md) | [FCGear Workbench/en](FCGear_Workbench/en.md) |\n| [FCGear WormGear/en](FCGear_WormGear/en.md) |\n\n\n---\n⏵ [documentation index](../README.md) > [External Workbenches](Category_External%20Workbenches.md) > [Addons](Category_Addons.md) > Category:FCGear/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_OpenSCAD.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_OpenSCAD.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_OpenSCAD.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "f933af5b0f621c74ac86f6335e2cd1299d555173b6e49154a0c322c3fd810524", "bytes": 1534, "tokens": 636, "text": "# Category:OpenSCAD/en\nThis category lists pages related to the [OpenSCAD Workbench](OpenSCAD_Workbench.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Artwork OpenSCAD/en](Artwork_OpenSCAD/en.md) | [Import OpenSCAD code/en](Import_OpenSCAD_code/en.md) | [OpenSCAD AddOpenSCADElement/en](OpenSCAD_AddOpenSCADElement/en.md) |\n| [OpenSCAD ColorCodeShape/en](OpenSCAD_ColorCodeShape/en.md) | [OpenSCAD CSG/en](OpenSCAD_CSG/en.md) | [OpenSCAD Edgestofaces/en](OpenSCAD_Edgestofaces/en.md) |\n| [OpenSCAD ExpandPlacements/en](OpenSCAD_ExpandPlacements/en.md) | [OpenSCAD ExplodeGroup/en](OpenSCAD_ExplodeGroup/en.md) | [OpenSCAD Hull/en](OpenSCAD_Hull/en.md) |\n| [OpenSCAD IncreaseToleranceFeature/en](OpenSCAD_IncreaseToleranceFeature/en.md) | [OpenSCAD MeshBoolean/en](OpenSCAD_MeshBoolean/en.md) | [OpenSCAD Minkowski/en](OpenSCAD_Minkowski/en.md) |\n| [OpenSCAD MirrorMeshFeature/en](OpenSCAD_MirrorMeshFeature/en.md) | [OpenSCAD Preferences/en](OpenSCAD_Preferences/en.md) | [OpenSCAD RefineShapeFeature/en](OpenSCAD_RefineShapeFeature/en.md) |\n| [OpenSCAD RemoveSubtree/en](OpenSCAD_RemoveSubtree/en.md) | [OpenSCAD ReplaceObject/en](OpenSCAD_ReplaceObject/en.md) | [OpenSCAD ResizeMeshFeature/en](OpenSCAD_ResizeMeshFeature/en.md) |\n| [OpenSCAD ScaleMeshFeature/en](OpenSCAD_ScaleMeshFeature/en.md) | [OpenSCAD Workbench/en](OpenSCAD_Workbench/en.md) |\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [User_Documentation](Category_User_Documentation.md) > Category:OpenSCAD/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_Part.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_Part.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_Part.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "177d66b85c65d1c44b85da549941e228129292f0b5cd2cae4efaa265ddeddbb0", "bytes": 4410, "tokens": 1903, "text": "# Category:Part/en\nThis category lists pages related to the [Part Workbench](Part_Workbench.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Aeroplane/en](Aeroplane/en.md) | [Artwork Part/en](Artwork_Part/en.md) | [Basic modeling tutorial/en](Basic_modeling_tutorial/en.md) |\n| [Constructive solid geometry/en](Constructive_solid_geometry/en.md) | [Creating a simple part with Part WB/en](Creating_a_simple_part_with_Part_WB/en.md) | [Draft ShapeString tutorial/en](Draft_ShapeString_tutorial/en.md) |\n| [Feature/en](Feature/en.md) | [O-X-Y Type Attachment Modes/en](O-X-Y_Type_Attachment_Modes/en.md) | [Part and PartDesign/en](Part_and_PartDesign/en.md) |\n| [Part Boolean/en](Part_Boolean/en.md) | [Part BooleanFragments/en](Part_BooleanFragments/en.md) | [Part Box/en](Part_Box/en.md) |\n| [Part BoxSelection/en](Part_BoxSelection/en.md) | [Part Builder/en](Part_Builder/en.md) | [Part Chamfer/en](Part_Chamfer/en.md) |\n| [Part CheckGeometry/en](Part_CheckGeometry/en.md) | [Part Circle/en](Part_Circle/en.md) | [Part Common/en](Part_Common/en.md) |\n| [Part Compound/en](Part_Compound/en.md) | [Part CompoundFilter/en](Part_CompoundFilter/en.md) | [Part Cone/en](Part_Cone/en.md) |\n| [Part CrossSections/en](Part_CrossSections/en.md) | [Part Cut/en](Part_Cut/en.md) | [Part Cylinder/en](Part_Cylinder/en.md) |\n| [Part Defeaturing/en](Part_Defeaturing/en.md) | [Part EditAttachment/en](Part_EditAttachment/en.md) | [Part ElementCopy/en](Part_ElementCopy/en.md) |\n| [Part Ellipse/en](Part_Ellipse/en.md) | [Part Ellipsoid/en](Part_Ellipsoid/en.md) | [Part ExplodeCompound/en](Part_ExplodeCompound/en.md) |\n| [Part Export/en](Part_Export/en.md) | [Part Extrude/en](Part_Extrude/en.md) | [Part Fillet/en](Part_Fillet/en.md) |\n| [Part Fuse/en](Part_Fuse/en.md) | [Part Helix/en](Part_Helix/en.md) | [Part Import/en](Part_Import/en.md) |\n| [Part JoinConnect/en](Part_JoinConnect/en.md) | [Part JoinCutout/en](Part_JoinCutout/en.md) | [Part JoinEmbed/en](Part_JoinEmbed/en.md) |\n| [Part Line/en](Part_Line/en.md) | [Part Loft Technical Details/en](Part_Loft_Technical_Details/en.md) | [Part Loft/en](Part_Loft/en.md) |\n| [Part MakeFace/en](Part_MakeFace/en.md) | [Part MakeSolid/en](Part_MakeSolid/en.md) | [Part Measure Angular/en](Part_Measure_Angular/en.md) |\n| [Part Measure Clear All/en](Part_Measure_Clear_All/en.md) | [Part Measure Linear/en](Part_Measure_Linear/en.md) | [Part Measure Refresh/en](Part_Measure_Refresh/en.md) |\n| [Part Measure Toggle 3D/en](Part_Measure_Toggle_3D/en.md) | [Part Measure Toggle All/en](Part_Measure_Toggle_All/en.md) | [Part Measure Toggle Delta/en](Part_Measure_Toggle_Delta/en.md) |\n| [Part Mirror/en](Part_Mirror/en.md) | [Part Offset/en](Part_Offset/en.md) | [Part Offset2D/en](Part_Offset2D/en.md) |\n| [Part Plane/en](Part_Plane/en.md) | [Part Point/en](Part_Point/en.md) | [Part PointsFromMesh/en](Part_PointsFromMesh/en.md) |\n| [Part Primitives/en](Part_Primitives/en.md) | [Part Prism/en](Part_Prism/en.md) | [Part ProjectionOnSurface/en](Part_ProjectionOnSurface/en.md) |\n| [Part RefineShape/en](Part_RefineShape/en.md) | [Part RegularPolygon/en](Part_RegularPolygon/en.md) | [Part ReverseShape/en](Part_ReverseShape/en.md) |\n| [Part Revolve/en](Part_Revolve/en.md) | [Part RuledSurface/en](Part_RuledSurface/en.md) | [Part Scale/en](Part_Scale/en.md) |\n| [Part scripting/en](Part_scripting/en.md) | [Part Section/en](Part_Section/en.md) | [Part ShapeFromMesh/en](Part_ShapeFromMesh/en.md) |\n| [Part SimpleCopy/en](Part_SimpleCopy/en.md) | [Part Slice/en](Part_Slice/en.md) | [Part SliceApart/en](Part_SliceApart/en.md) |\n| [Part Sphere/en](Part_Sphere/en.md) | [Part Spiral/en](Part_Spiral/en.md) | [Part Sweep/en](Part_Sweep/en.md) |\n| [Part Thickness/en](Part_Thickness/en.md) | [Part TopoShape/en](Part_TopoShape/en.md) | [Part Torus/en](Part_Torus/en.md) |\n| [Part TransformedCopy/en](Part_TransformedCopy/en.md) | [Part Tube/en](Part_Tube/en.md) | [Part Wedge/en](Part_Wedge/en.md) |\n| [Part Workbench/en](Part_Workbench/en.md) | [Part XOR/en](Part_XOR/en.md) | [Shape/en](Shape/en.md) |\n| [Thread for Screw Tutorial/en](Thread_for_Screw_Tutorial/en.md) | [Topological naming problem/en](Topological_naming_problem/en.md) | [Whiffle Ball tutorial/en](Whiffle_Ball_tutorial/en.md) |\n|\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [User_Documentation](Category_User_Documentation.md) > Category:Part/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_PartDesign.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_PartDesign.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_PartDesign.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "b92bdd36d6bd982fbaf28349800af47d555edffdb9e7ce1ff67e7aa153b6ca54", "bytes": 4698, "tokens": 1937, "text": "# Category:PartDesign/en\nThis category lists pages related to the [PartDesign Workbench](PartDesign_Workbench.md).\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Artwork PartDesign/en](Artwork_PartDesign/en.md) | [Basic Attachment Tutorial/en](Basic_Attachment_Tutorial/en.md) | [Basic Part Design Tutorial 019/en](Basic_Part_Design_Tutorial_019/en.md) |\n| [Basic Part Design Tutorial/en](Basic_Part_Design_Tutorial/en.md) | [Body/en](Body/en.md) | [Configuration Tables/en](Configuration_Tables/en.md) |\n| [Creating a simple part with PartDesign/en](Creating_a_simple_part_with_PartDesign/en.md) | [Datum/en](Datum/en.md) | [Draft ShapeString tutorial/en](Draft_ShapeString_tutorial/en.md) |\n| [Feature editing/en](Feature_editing/en.md) | [Feature/en](Feature/en.md) | [Part and PartDesign/en](Part_and_PartDesign/en.md) |\n| [PartDesign AdditiveBox/en](PartDesign_AdditiveBox/en.md) | [PartDesign AdditiveCone/en](PartDesign_AdditiveCone/en.md) | [PartDesign AdditiveCylinder/en](PartDesign_AdditiveCylinder/en.md) |\n| [PartDesign AdditiveEllipsoid/en](PartDesign_AdditiveEllipsoid/en.md) | [PartDesign AdditiveHelix/en](PartDesign_AdditiveHelix/en.md) | [PartDesign AdditiveLoft/en](PartDesign_AdditiveLoft/en.md) |\n| [PartDesign AdditivePipe/en](PartDesign_AdditivePipe/en.md) | [PartDesign AdditivePrism/en](PartDesign_AdditivePrism/en.md) | [PartDesign AdditiveSphere/en](PartDesign_AdditiveSphere/en.md) |\n| [PartDesign AdditiveTorus/en](PartDesign_AdditiveTorus/en.md) | [PartDesign AdditiveWedge/en](PartDesign_AdditiveWedge/en.md) | [PartDesign Body/en](PartDesign_Body/en.md) |\n| [PartDesign Boolean/en](PartDesign_Boolean/en.md) | [PartDesign Chamfer/en](PartDesign_Chamfer/en.md) | [PartDesign Clone/en](PartDesign_Clone/en.md) |\n| [PartDesign CoordinateSystem/en](PartDesign_CoordinateSystem/en.md) | [PartDesign Draft/en](PartDesign_Draft/en.md) | [PartDesign Examples/en](PartDesign_Examples/en.md) |\n| [PartDesign Feature/en](PartDesign_Feature/en.md) | [PartDesign Fillet/en](PartDesign_Fillet/en.md) | [PartDesign Groove/en](PartDesign_Groove/en.md) |\n| [PartDesign Hole/en](PartDesign_Hole/en.md) | [PartDesign InvoluteGear/en](PartDesign_InvoluteGear/en.md) | [PartDesign Line/en](PartDesign_Line/en.md) |\n| [PartDesign LinearPattern/en](PartDesign_LinearPattern/en.md) | [PartDesign Migrate/en](PartDesign_Migrate/en.md) | [PartDesign Mirrored/en](PartDesign_Mirrored/en.md) |\n| [PartDesign MoveFeature/en](PartDesign_MoveFeature/en.md) | [PartDesign MoveFeatureInTree/en](PartDesign_MoveFeatureInTree/en.md) | [PartDesign MoveTip/en](PartDesign_MoveTip/en.md) |\n| [PartDesign MultiTransform/en](PartDesign_MultiTransform/en.md) | [PartDesign NewSketch/en](PartDesign_NewSketch/en.md) | [PartDesign Pad/en](PartDesign_Pad/en.md) |\n| [PartDesign Plane/en](PartDesign_Plane/en.md) | [PartDesign Pocket/en](PartDesign_Pocket/en.md) | [PartDesign Point/en](PartDesign_Point/en.md) |\n| [PartDesign PolarPattern/en](PartDesign_PolarPattern/en.md) | [PartDesign Preferences/en](PartDesign_Preferences/en.md) | [PartDesign Revolution/en](PartDesign_Revolution/en.md) |\n| [PartDesign Scaled/en](PartDesign_Scaled/en.md) | [PartDesign ShapeBinder/en](PartDesign_ShapeBinder/en.md) | [PartDesign Sprocket/en](PartDesign_Sprocket/en.md) |\n| [PartDesign SubShapeBinder/en](PartDesign_SubShapeBinder/en.md) | [PartDesign SubtractiveBox/en](PartDesign_SubtractiveBox/en.md) | [PartDesign SubtractiveCone/en](PartDesign_SubtractiveCone/en.md) |\n| [PartDesign SubtractiveCylinder/en](PartDesign_SubtractiveCylinder/en.md) | [PartDesign SubtractiveEllipsoid/en](PartDesign_SubtractiveEllipsoid/en.md) | [PartDesign SubtractiveHelix/en](PartDesign_SubtractiveHelix/en.md) |\n| [PartDesign SubtractiveLoft/en](PartDesign_SubtractiveLoft/en.md) | [PartDesign SubtractivePipe/en](PartDesign_SubtractivePipe/en.md) | [PartDesign SubtractivePrism/en](PartDesign_SubtractivePrism/en.md) |\n| [PartDesign SubtractiveSphere/en](PartDesign_SubtractiveSphere/en.md) | [PartDesign SubtractiveTorus/en](PartDesign_SubtractiveTorus/en.md) | [PartDesign SubtractiveWedge/en](PartDesign_SubtractiveWedge/en.md) |\n| [PartDesign Thickness/en](PartDesign_Thickness/en.md) | [PartDesign WizardShaft/en](PartDesign_WizardShaft/en.md) | [PartDesign Workbench/en](PartDesign_Workbench/en.md) |\n| [Sketcher Examples/en](Sketcher_Examples/en.md) | [Thread for Screw Tutorial/en](Thread_for_Screw_Tutorial/en.md) | [Toothbrush Head Stand/en](Toothbrush_Head_Stand/en.md) |\n| [Topological naming problem/en](Topological_naming_problem/en.md) |\n\n\n---\n⏵ [documentation index](../README.md) > [Workbenches](Category_Workbenches.md) > [User_Documentation](Category_User_Documentation.md) > Category:PartDesign/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_Preferences.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_Preferences.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_Preferences.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "84b6df0085e6223203c8dca9e8dd977d98b1ec8cb947a387d2a9896bb0072003", "bytes": 1156, "tokens": 426, "text": "# Category:Preferences/en\nThis category lists all existing Preference menus of different FreeCAD workbenches. See [Preferences_Editor#Workbench_preferences](Preferences_Editor#Workbench_preferences.md)\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Assembly Preferences/en](Assembly_Preferences/en.md) | [BIM Preferences/en](BIM_Preferences/en.md) | [CAM Preferences/en](CAM_Preferences/en.md) |\n| [Customize Toolbars/en](Customize_Toolbars/en.md) | [Draft Preferences/en](Draft_Preferences/en.md) | [FEM Preferences/en](FEM_Preferences/en.md) |\n| [Import Export Preferences/en](Import_Export_Preferences/en.md) | [OpenSCAD Preferences/en](OpenSCAD_Preferences/en.md) | [PartDesign Preferences/en](PartDesign_Preferences/en.md) |\n| [Preferences Editor/en](Preferences_Editor/en.md) | [Raytracing Preferences/en](Raytracing_Preferences/en.md) | [Sketcher Preferences/en](Sketcher_Preferences/en.md) |\n| [Spreadsheet Preferences/en](Spreadsheet_Preferences/en.md) | [Start Preferences/en](Start_Preferences/en.md) | [TechDraw Preferences/en](TechDraw_Preferences/en.md) |\n|\n\n\n---\n⏵ [documentation index](../README.md) > Category:Preferences/en\n"} {"id": "freecad-docs:wiki/translations/en/Category_Wiki.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Category_Wiki.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Category_Wiki.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "9c5ff43a8620749798653b641b2040fcb90111274166117e7a6e6d5c5b1c48ae", "bytes": 307, "tokens": 134, "text": "# Category:Wiki/en\n\n\n### Contents\n\n| | | |\n| --- | --- | --- |\n| [Glossary/en](Glossary/en.md) | [Localisation Sidebar/en](Localisation_Sidebar/en.md) | [Localisation/en](Localisation/en.md) |\n| [WikiPages/en](WikiPages/en.md) |\n\n\n---\n⏵ [documentation index](../README.md) > Category:Wiki/en\n"} {"id": "freecad-docs:wiki/translations/en/Cfd_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Cfd_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Cfd_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "567df68f85341020caa418b7eccb8d0a9e1c48458c0429718cb727265c9cf2a9", "bytes": 1508, "tokens": 597, "text": "# Cfd Workbench/en\n## Introduction\n\n\nComputional Fluid Dynamics (CFD) for FreeCAD based on OpenFOAM solver\n\n\"\"\n\n## References\n\n- Author: qingfengxia Qingfeng Xia\n- Home page: \n- Source code on \n\n## Tools\n\nDetailed description\n\n## Installation\n\n### Automatic installation \n\nThis workbench can be installed from the [Addon Manager](Std_AddonMgr.md).\n\n### From GitHub \n\nHow to [here](https://github.com/qingfengxia/Cfd)\n\n**Prerequisites**\n\nTo use CFD for FreeCAD\n\n- FreeCAD version \\> 0.17\n-\n**Linux Installation Instructions** (From GitHub)\n\n**Windows Installation Instructions** (From GitHub)\n\n**Mac Installation Instructions** (From GitHub)\n\n## Links to CFD WB \n\n- Workbench Wiki:\n- FreeCAD Wiki:\n- FreeCAD Forum: [7895](http://forum.freecadweb.org/viewtopic.php?f=24&t=7895), [11652](http://forum.freecadweb.org/viewtopic.php?t=11652) [16947](http://forum.freecadweb.org/viewtopic.php?t=16947), [17322](http://forum.freecadweb.org/viewtopic.php?t=17322)\n- Tutorials:\n- Videos:\n- Files:\n- Report bugs: Please report bugs at\n\n## Other useful links \n\n- [Macros recipes](Macros_recipes.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Sandbox](Category_Sandbox.md) > [User Documentation](Category_User%20Documentation.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > Cfd Workbench/en\n"} {"id": "freecad-docs:wiki/translations/en/Curves_PipeshellProfile.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Curves_PipeshellProfile.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Curves_PipeshellProfile.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a46623908ad9484afbed42b399f568aa1dd84573bdcd3c2063ac25a7ab5d1544", "bytes": 1223, "tokens": 454, "text": "---\n GuiCommand:\n Name: Curves PipeshellProfile\n MenuLocation: Surfaces , Pipeshell profile\n Workbenches: Curves_Workbench\n SeeAlso: Curves_Pipeshell\n---\n\n# Curves PipeshellProfile/en\n\n## Description\n\nThe \"\" [Curves PipeshellProfile](Curves_PipeshellProfile.md) creates a Profile object for Pipeshell. This tool is part of the [external workbench](External_workbenches.md) called [Curves](Curves_Workbench.md).\n\n## Usage\n\n1. Switch to the \"\" [Curves](Curves_Workbench.md) workbench (install from \"\" [Addon Manager](Std_AddonMgr.md) is necessary, if not previously installed)\n2. To invoke the command, do one of the following:\n - Press the \"\" button in the Curves toolbar\n - Use the **Surfaces → Pipeshell profile** entry in the dropdown menu.\n\n## Notes\n\n## Limitations\n\n## Properties\n\n## Scripting\n\n\n{{Curves Tools navi\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > [Curves](Category_Curves.md) > Curves PipeshellProfile/en\n"} {"id": "freecad-docs:wiki/translations/en/Curves_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Curves_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Curves_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "6f6e167010173c56d48d0569962adfe3132ced291213dc52414e4d30380450e0", "bytes": 4688, "tokens": 1849, "text": "# Curves Workbench/en\n}\n\n## Introduction\n\n\"Curves \n\nThe Curves workbench is an [External workbench](External_workbenches.md) that is Python based with a collection of tools for NURBS curves and surfaces. This workbench is developed with FreeCAD Master and OCC 7.4.\n\nNote: Some tools may not work with earlier versions.\n\n## Installation\n\nDownload the Curves workbench via the \"\" [Addon Manager](Std_AddonMgr.md). Select the **Tools → Addon Manager** option from the menu.\n\n## References\n\n- Developer: \\@Chris_G\n- Github: \n- Discussion: \n- YouTube tutorial using curves workbench: \n- Dailymotion tutorial, tide bottle, demoing curves workbench: \n\n## Tools\n\n- \"\" [Curves Line](Curves_Line.md): Create a parametric line between two vertices.\n- \"\" [Curves EditableSpline](Curves_EditableSpline.md): Create a freehand B-Spline curve.\n- \"\" [Curves ExtendCurve](Curves_ExtendCurve.md): Extends the selected edge.\n- \"\" [Curves JoinCurve](Curves_JoinCurve.md): Joins the selected edges into BSpline Curves.\n- \"\" [Curves SplitCurve](Curves_SplitCurve.md): Splits the selected edge.\n- \"\" [Curves Discretize](Curves_Discretize.md): Discretize an edge or a wire.\n- \"\" [Curves Interpolate](Curves_Interpolate.md): Interpolate points with a BSpline curve.\n- \"\" [Curves ParametricComb](Curves_ParametricComb.md): Creates a parametric Comb plot on selected edges.\n- \"\" [Curves ZebraTool](Curves_ZebraTool.md): Zebra texture for surface inspection.\n- \"\" [Curves ParametricSolid](Curves_ParametricSolid.md): Make a parametric solid from selected faces.\n- \"\" [Curves IsoCurve](Curves_IsoCurve.md): Create an IsoCurve from a face.\n- \"\" [Curves SketchOnSurface](Curves_SketchOnSurface.md): Map a sketch on to a surface.\n- \"\" [Curves ProfileSupport](Curves_ProfileSupport.md): Creates a support plane for sketches.\n- \"\" [Curves PasteSVG](Curves_PasteSVG.md): Pastes the SVG content of the clipboard.\n- \"\" [Curves PipeshellProfile](Curves_PipeshellProfile.md): Creates a Profile object for PipeShell.\n- \"\" [Curves Pipeshell](Curves_Pipeshell.md): Creates a Pipeshell sweep object.\n- \"\" [Curves GordonSurface](Curves_GordonSurface.md): Creates a surface that skins a network of curves.\n- \"\" [Curves SegmentSurface](Curves_SegmentSurface.md): Segment a surface on isocurves.\n- \"\" [Curves ToConsole](Curves_ToConsole.md): Moves objects to the console.\n- \"\" [Curves CompressionSpring](Curves_CompressionSpring.md): Creates a compression spring.\n- \"\" [Curves ReflectLines](Curves_ReflectLines.md): Creates the reflect lines on a shape, according to a view direction.\n- \"\" [Curves MultiLoft](Curves_MultiLoft.md): Loft profile objects made of multiple faces in parallel.\n\n\n{{Curves Tools navi\n\n}}\n\n\n---\n⏵ [documentation index](../README.md) > [External Workbenches](Category_External%20Workbenches.md) > [Addons](Category_Addons.md) > [Curves](Category_Curves.md) > Curves Workbench/en\n"} {"id": "freecad-docs:wiki/translations/en/Customize_Toolbars.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Customize_Toolbars.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Customize_Toolbars.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "018ec460eba67e123b7277f6476747f813c58bcd153c191c51bb3a9404f224c9", "bytes": 4467, "tokens": 1501, "text": "---\n TutorialInfo:\n Topic: Customize Toolbars\n Level: Beginner\n Time: 5 minutes\n Author: User:Mario52\n FCVersion: All\n SeeAlso: Interface_Customization.\n---\n\n# Customize Toolbars/en\n\n\n## Synopsis\n\nThis tutorial shows how to add a button for a [macro](Macro.md) to a custom toolbar.\n\nFor more general information see [Interface Customization](Interface_Customization.md).\n\n## Usage\n\n**1.** Find the Customize Menu\n\n- Click **Main Menu → Tools → Customize**,\n\n\"Customize\" \n\n- or right click on any toolbar.\n\n\"Right \n\n- The Customize window appears.\n\n\"The \n\n**2.** Make a Macro to a Macro-Tool\n\n- Select the \\\"Macro\\\" tab.\n\n- To add an icon for the provided macro click the Pixmap button (labelled **... **).\n\n\"Select \n\n- Search for an appropriate icon from amongst FreeCAD\\'s existing icons,\n\n\n
\n\n      \\[or add your own icon by clicking **Add icons...**\\].                  (expand for an example)\n\n\n
\n\n\"Add \n\n     \\[You will get a file selection window, select your custom image file (PNG format, 64x64 pixels)\\]\n\n\"Get \n\n\n
\n\n\n
\n\n- Select your icon and click **OK**.\n\n\"Select \n\n- The icon you selected is now displayed next to the Pixmap button labelled **...**.\n\n\"Your \n\n- Select the provided macro in line **Macro:** and specify a **Menu text**: (which will appear as the text label in the menu); also fill in the *\\'Tool Tip\\':* (which is the text that will appear when a mouse is over the button on the toolbar); further lines are optional.\n\n- Click the button **Add**.\n\n\"Click \n\n- The button of the macro-tool is now created.\n\n\"Your \n\n**3.** Create a toolbar outside the workbench **Macro** which contains the created **Macro-tool**\n\n- Select the **Toolbars** tab and choose the workbench (for which the toolbar is provided) in the drop down on the right (**Part** in this example).\n\n     \\[Since version 0.15 there is a  **[ Global**  toolbar. If this is selected, the provided toolbar will be in each workbench.\\]\n\n\"Toolbars \n\n- In the dropdown on the left select **Macros**.\n\n\"Macros\" \n\n- The macro-tool with its icon appears in the list.\n\n\"Your \n\n- Click the button **New...**\n\n\"Click \n\n- In the window \\\"New Toolbar\\\" enter the name of the provided extra toolbar for the **Part** Workbench and click **OK**\n\n\"Enter \n\n- The toolbar is now created.\n\n- To add the created macro-tool to this toolbar, select it in the left window and then click the **Button** with the arrow pointing right.\n\n\"Select \n\n- You have created now a toolbar called \\\"Camera\\\" (with the Macro-tool **Camera** in it)\n\n- Click the **Close** button.\n\n\"Close\" \n\n- Your new toolbar is now contained in the toolbars\\' right-click menu. Its Icons (in our example only the camera) are visible, if the toolbar is activated (blue checkmark).\n\n\"New\n\n\n---\n⏵ [documentation index](../README.md) > [Preferences](Category_Preferences.md) > Customize Toolbars/en\n"} {"id": "freecad-docs:wiki/translations/en/Dodo_Workbench.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Dodo_Workbench.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Dodo_Workbench.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "67d3d742225a5d517090c1a8ed6adff27cce486aab4c45e8e89fc910a34216a6", "bytes": 150, "tokens": 69, "text": "# Dodo Workbench/en\n1. REDIRECT [Flamingo_Workbench/en](Flamingo_Workbench/en.md)\n\n\n---\n⏵ [documentation index](../README.md) > Dodo Workbench/en\n"} {"id": "freecad-docs:wiki/translations/en/Draft_Constrain.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Draft_Constrain.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Draft_Constrain.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "5143a544198269305c97c0a854ec5557b646fb4989f34ccc76a23a974b93741f", "bytes": 2882, "tokens": 895, "text": "# Draft Constrain/en\n## Description\n\nApart from entering coordinates or using [snapping](Draft_Snap.md), there is a feature called constraining to help you draw accurately in the \"\" [Draft Workbench](Draft_Workbench.md) and the \"\" [BIM Workbench](BIM_Workbench.md). For each subsequent point you can constrain the movement of the cursor to the X, Y, or Z direction of the [working plane](Draft_SelectPlane.md) coordinate system. This can for example be used to create a perfectly vertical line.\n\nConstraining is available with most [Draft](Draft_Workbench.md) and [BIM](BIM_Workbench.md) commands.\n\n![](images/Draft_Constrain_taskpanel_example.png ) \n*While the cursor is constrained the task panel locks the values that are not being modified*\n\n## Usage horizontal and vertical constraints \n\n1. Choose a [Draft](Draft_Workbench.md) or [BIM](BIM_Workbench.md) command to create your geometry.\n2. Pick a first point. A previous point is required.\n3. Do one of the following:\n - For a horizontal constraint: move the cursor to the left or right of the previous point.\n - For a vertical constraint: move the cursor above or below the previous point.\n4. Hold down **Shift**.\n5. The cursor is now constrained.\n6. Pick the next point.\n7. If the command is still active: optionally release **Shift** to disable the constraint.\n8. Always release **Shift** when the command is finished.\n\n## Usage X, Y and Z constraints \n\n1. Choose a [Draft](Draft_Workbench.md) or [BIM](BIM_Workbench.md) command to create your geometry.\n2. Pick a first point. A previous point is required.\n3. Press **X**, **Y** or **Z** to specify the direction.\n4. The cursor is now constrained.\n5. Pick the next point.\n6. If the command is still active optionally do one of the following:\n - Press the same key to disable the constraint.\n - Press one of the two other keys to constrain in a different direction.\n7. X, Y and Z constraints are automatically disabled when the command is finished.\n\n## Notes\n\n- Constraining can be combined with [snapping](Draft_Snap.md).\n- The [Draft Offset](Draft_Offset.md) command and [Draft Trimex](Draft_Trimex.md) command use a different type of constraining, namely to restrict the operation to a certain segment.\n\n## Preferences\n\nSee also: [Preferences Editor](Preferences_Editor.md) and [Draft Preferences](Draft_Preferences.md).\n\n- The default **Constrain modifier** key, **Shift**, can be changed: **Edit → Preferences... → Draft → Grid and snapping → Constrain modifier**.\n- The **X**, **Y** and **Z** shortcuts can be changed: **Edit → Preferences... → Draft → Interface → In-command shortcuts**.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Constrain/en\n"} {"id": "freecad-docs:wiki/translations/en/Draft_Mirror.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Draft_Mirror.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Draft_Mirror.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "a4fa19c94bbbd2e54ab05536b8fb90696c002a3e5f5c19d54081a626d8e1c5b0", "bytes": 5796, "tokens": 1929, "text": "---\n GuiCommand:\n Name: Draft Mirror\n MenuLocation: Modification , Mirror
Modify , Mirror\n Workbenches: Draft_Workbench, BIM_Workbench\n Shortcut: **M** **I**\n SeeAlso: Draft_Clone\n---\n\n# Draft Mirror/en\n\n## Description\n\nThe \"\" **Draft Mirror** command creates mirrored copies, [Part Mirror](Part_Mirror.md) objects, from selected objects. A [Part Mirror](Part_Mirror.md) object is parametric, it will update if its source object changes.\n\nThe command can be used on 2D objects created with the [Draft Workbench](Draft_Workbench.md) or [Sketcher Workbench](Sketcher_Workbench.md), but also on many 3D objects such as those created with the [Part Workbench](Part_Workbench.md), [PartDesign Workbench](PartDesign_Workbench.md) or [BIM Workbench](BIM_Workbench.md).\n\n\"\" \n*Mirroring an object*\n\n## Usage\n\nSee also: [Draft Snap](Draft_Snap.md) and [Draft Constrain](Draft_Constrain.md).\n\n1. Optionally select one or more objects.\n2. There are several ways to invoke the command:\n - Press the ** [Mirror](Draft_Mirror.md)** button.\n - [Draft](Draft_Workbench.md): Select the **Modification → Mirror** option from the menu.\n - [BIM](BIM_Workbench.md): Select the **Modify → Mirror** option from the menu.\n - Use the keyboard shortcut: **M** then **I**.\n3. If you have not yet selected an object: select an object in the [3D view](3D_view.md).\n4. The **Mirror** task panel opens. See [Options](#Options.md) for more information.\n5. Pick the first point of the mirror plane in the [3D view](3D_view.md), or type coordinates and press the ** Enter point** button.\n6. Pick the second point of the mirror plane in the [3D view](3D_view.md), or type coordinates and press the ** Enter point** button.\n7. The mirror plane is defined by the selected points and the normal of the [Draft working plane](Draft_SelectPlane.md).\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- To manually enter coordinates enter the X, Y and Z component, and press **Enter** after each. Or you can press the ** Enter point** button when you have the desired values. It is advisable to move the pointer out of the [3D view](3D_view.md) before entering coordinates.\n- Press **R** or click the **Relative** checkbox to toggle relative mode. If relative mode is on, the coordinates of the second point are relative to the first point, else they are relative to the coordinate system origin.\n- Press **G** or click the **Global** checkbox to toggle global mode. If global mode is on, coordinates are relative to the global coordinate system, else they are relative to the [working plane](Draft_SelectPlane.md) coordinate system.\n- Press **S** to switch [Draft snapping](Draft_Snap.md) on or off.\n- Press **Esc** or the **Close** button to abort the command.\n\n## Notes\n\n- Mirrored copies of [Draft Lines](Draft_Line.md), [Draft Wires](Draft_Wire.md), [Draft Arcs](Draft_Arc.md) and [Draft Circles](Draft_Circle.md) can be turned into independent editable Draft objects by using [Draft Downgrade](Draft_Downgrade.md) and then [Draft Upgrade](Draft_Upgrade.md).\n- The [Part SimpleCopy](Part_SimpleCopy.md) command can be used to create a copy of a mirrored object that is not linked to its source object.\n\n## Properties\n\nSee also: [Property editor](property_editor.md).\n\nA [Part Mirror](Part_Mirror.md) 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- **Source|Link**: specifies the object that is mirrored.\n\n\n{{TitleProperty|Plane}}\n\n- **Base|Vector**: specifies the base point of the mirror plane.\n\n- **Normal|Vector**: specifies the normal direction of the mirror plane.\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nTo mirror objects use the `mirror` method of the Draft module.\n\n\n```python\nmirrored_list = mirror(objlist, p1, p2)\n```\n\n- `objlist`contains the objects to be mirrored. It is either a single object or a list of objects.\n\n- `p1`is the first point of the mirror plane.\n\n- `p2`is the second point of the mirror plane.\n\n- If the [Draft working plane](Draft_SelectPlane.md) is available the alignment of the mirror plane is determined by its normal, else the view direction of the camera in the active [3D view](3D_view.md) is used. If the graphical interface is not available the Z axis is used.\n\n- `mirrored_list`is returned with the new `Part::Mirroring` objects. It is either a single object or a list of objects, depending on `objlist`.\n\nExample:\n\n\n```python\nimport FreeCAD as App\nimport Draft\n\ndoc = App.newDocument()\n\nplace = App.Placement(FreeCAD.Vector(1000, 0, 0), App.Rotation())\npolygon1 = Draft.make_polygon(3, 750)\npolygon2 = Draft.make_polygon(5, 750, placement=place)\n\np1 = App.Vector(2000, -1000, 0)\np2 = App.Vector(2000, 1000, 0)\n\nline1 = Draft.make_line(p1, p2)\nmirrored1 = Draft.mirror(polygon1, p1, p2)\n\nLine2 = Draft.make_line(-p1, -p2)\nmirrored2 = Draft.mirror([polygon1, polygon2], -p1, -p2)\n\ndoc.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Mirror/en\n"} {"id": "freecad-docs:wiki/translations/en/Draft_Offset.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Draft_Offset.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Draft_Offset.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "3676b3a2a9f62fb0edf1a6edd676cf5b432aa59f88ce843819db759bf620e3ef", "bytes": 5942, "tokens": 1996, "text": "---\n GuiCommand:\n Name: Draft Offset\n MenuLocation: Modification , Offset
Modify , Offset\n Workbenches: Draft_Workbench, BIM_Workbench\n Shortcut: **O** **S**\n SeeAlso: Part_Offset2D\n---\n\n# Draft Offset/en\n\n## Description\n\nThe \"\" **Draft Offset** command offsets each segment of a selected object over a given distance, or creates an offset copy of the selected object.\n\n\"\" \n*Offsetting a Draft Wire*\n\n## Usage\n\nSee also: [Draft Snap](Draft_Snap.md) and [Draft Constrain](Draft_Constrain.md).\n\n1. Optionally select one object. The object must lie on the current [Draft working plane](Draft_SelectPlane.md).\n2. There are several ways to invoke the command:\n - Press the ** [Offset](Draft_Offset.md)** button.\n - [Draft](Draft_Workbench.md): Select the **Modification → Offset** option from the menu.\n - [BIM](BIM_Workbench.md): Select the **Modify → Offset** option from the menu.\n - Use the keyboard shortcut: **O** then **S**.\n3. If you have not yet selected an object: select an object in the [3D view](3D_view.md).\n4. The **Offset** task panel opens. See [Options](#Options.md) for more information.\n5. To define the offset distance do one of the following:\n - Pick a point in the [3D view](3D_view.md).\n - Enter a numerical value:\n 1. Make sure the pointer is on the correct side of the object in the [3D view](3D_view.md).\n 2. Do not move the pointer out of the [3D view](3D_view.md).\n 3. Enter a **Distance**.\n 4. Press **Enter** to finish the command.\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 (for version 1.0).\n\n- If the **OCC-style offset** checkbox is checked a special offset style is used: open [Draft Wires](Draft_Wire.md) are offset on both sides, and new edges are connected with rounded corners. This only works for planar objects with at least two edges. Note that with this style a new non-parametric object is created, and if copy mode is off the original object is deleted.\n- Press **C** or click the **Copy** checkbox to toggle copy mode. If copy mode is on, the command will create an offset copy instead of offsetting the original object.\n- Holding down **Alt** before picking points in the [3D view](3D_view.md) will also toggle copy mode. While **Alt** is held down multiple offset points can be picked. Release **Alt** to finish the command and see the created copies.\n- Hold down **Shift** to keep the offset distance linked to the current segment.\n- Press **S** to switch [Draft snapping](Draft_Snap.md) on or off.\n- Press **Esc** or the **Close** button to abort the command.\n\n## Notes\n\n- To create an offset version of a [Draft BSpline](Draft_BSpline.md) its points are offset individually, and from the new points a new spline is calculated. This new spline is not parallel to the original spline. For an exact parallel offset of a [Draft BSpline](Draft_BSpline.md) the [Part Offset2D](Part_Offset2D.md) command should be used.\n- The Draft Offset command cannot handle [Draft BezCurves](Draft_BezCurve.md). Use the [Part Offset2D](Part_Offset2D.md) command instead.\n\n## Scripting\n\nSee also: [Autogenerated API documentation](https://freecad.github.io/SourceDoc/) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nTo offset objects use the `offset` method of the Draft module. The method can only handle [Draft Wires](Draft_Wire.md), [Draft Circles](Draft_Circle.md), [Draft Rectangles](Draft_Rectangle.md), [Draft Polygons](Draft_Polygon.md) and [Draft BSplines](Draft_BSpline.md).\n\n\n```python\noffset_obj = offset(obj, delta, copy=False, bind=False, sym=False, occ=False)\n```\n\n- `obj`is the object to be offset.\n\n- `delta`contains the offset information:\n\n - For [Draft Wires](Draft_Wire.md), [Draft Rectangles](Draft_Rectangle.md) and [Draft Polygons](Draft_Polygon.md) it is an offset vector that must be perpendicular to the first segment of the object.\n - For [Draft Circles](Draft_Circle.md) it is the new radius.\n - For [Draft BSplines](Draft_BSpline.md) it is a list of new points.\n\n- If `copy` is `True` the original object is kept and a new object is created.\n\n- If `bind` is `True` a face is created by connecting the shape of the original object and the shape of its offset. This only works for open [Draft Wires](Draft_Wire.md).\n\n- If `sym` is `True`, and `bind` is `True` as well, the offset is made on both sides of the original object, the total width being the length of the given vector. This only works for open [Draft Wires](Draft_Wire.md).\n\n- If `occ` is `True` OCC-style offsetting is used. See [Options](#Options.md). If `occ` is `True` the `bind` and `sym` arguments are ignored.\n\n- `offset_obj`is returned with the original offset object, or with the new object. If `bind` is `True` or `occ` is `True`, the new object is a `[Part::Feature](Part_Feature.md)` object.\n\nExample:\n\n\n```python\nimport FreeCAD as App\nimport Draft\n\ndoc = App.newDocument()\n\np1 = App.Vector(0, 0, 0)\np2 = App.Vector(1500, 2000, 0)\np3 = App.Vector(4000, 0, 0)\n\nwire = Draft.make_wire([p1, p2, p3])\ndoc.recompute()\n\nvector = App.Vector(-200, 150, 0)\noffset1 = Draft.offset(wire, vector, copy=True, bind=True, sym=True)\noffset2 = Draft.offset(wire, 3*vector, copy=True)\noffset3 = Draft.offset(wire, 6*vector, copy=True)\noffset4 = Draft.offset(wire, 9*vector, copy=True)\noffset5 = Draft.offset(wire, 1.5*vector, copy=True, occ=True)\n\ndoc.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Offset/en\n"} {"id": "freecad-docs:wiki/translations/en/Draft_Snap_Grid.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Draft_Snap_Grid.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Draft_Snap_Grid.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "48cfbd3bd6c917c6189976b6edf78cf6041ea7f5424743a220d13382a1c496d6", "bytes": 2296, "tokens": 819, "text": "---\n GuiCommand:\n Name: Draft Snap Grid\n MenuLocation: Snapping , Snap grid\n Workbenches: Draft_Workbench, BIM_Workbench\n SeeAlso: Draft_Snap, Draft_Snap_Lock, Draft_ToggleGrid, Draft_SelectPlane\n---\n\n# Draft Snap Grid/en\n\n## Description\n\nThe \"\" **Draft Snap Grid** option snaps to the intersections of grid lines.\n\n![](images/Draft_Snap_Grid_example.png ) \n*Snapping the second point of a line to the grid*\n\n## Usage\n\nFor general information about snapping see [Draft Snap](Draft_Snap.md).\n\n1. Optionally change the [working plane and/or the grid](Draft_SelectPlane.md).\n2. Make sure snapping is enabled. See \"\" [Draft Snap Lock](Draft_Snap_Lock.md).\n3. If **Draft Snap Grid** is not active do one of the following:\n - Press the ** [Snap grid](Draft_Snap_Grid.md)** button in the Draft snap toolbar.\n - [Draft](Draft_Workbench.md): Hold down the **** button in the [Draft snap widget](Draft_snap_widget.md) and in the menu that opens select the ** Snap grid** option.\n - [BIM](BIM_Workbench.md): Select the **Snapping → Snap grid** option from the menu, or from the [3D view](3D_view.md) context menu.\n4. Choose a Draft or BIM command to create your geometry.\n5. Note that you can also change snap options while a command is active.\n6. If required use [Draft ToggleGrid](Draft_ToggleGrid.md) to display the grid. The grid must be visible for this snap option to work.\n7. Move the cursor near the intersection of two grid lines.\n8. If an intersection is found the point is marked and the \"\" icon is displayed near the cursor.\n9. Click to confirm the point.\n\n## Preferences\n\nSee [Draft Snap](Draft_Snap#Preferences.md).\n\n- Several grid preferences are available: **Edit → Preferences... → Draft → Grid and snapping**.\n\n\n---\n⏵ [documentation index](../README.md) > [Draft](Draft_Workbench.md) > Draft Snap Grid/en\n"} {"id": "freecad-docs:wiki/translations/en/Expressions.md", "source": "freecad-docs", "repository": "https://github.com/FreeCAD/FreeCAD-documentation", "revision": "0499378a238ce4c77c643b9cc4a03d0947381e45", "path": "wiki/translations/en/Expressions.md", "url": "https://github.com/FreeCAD/FreeCAD-documentation/blob/0499378a238ce4c77c643b9cc4a03d0947381e45/wiki/translations/en/Expressions.md", "license": "CC0-1.0", "encoding": "utf-8", "sha256": "69ac1a6b6bbbfc75a830c5e65ed46ce9330f417c560bfdfe966b784e80a0ba42", "bytes": 127112, "tokens": 16579, "text": "# Expressions/en\n## Overview\n\nIt is possible to define properties using mathematical expressions. In the GUI, spin boxes or input fields that are bound to properties show a blue icon \"\" when activated. Clicking on the icon or typing the equal sign **=** opens the expression editor for that particular property. If the input field shows a **...** button instead of an icon, the expression editor can be opened by right-clicking the property and selecting **Expression...** from the context menu.\n\nA FreeCAD expression is a mathematical expression using the standard mathematical [operators](#Supported_operators.md), [functions](#Supported_functions.md) and [predefined constants](#Supported_constants.md) as described below. In addition, the expression may reference object properties, and also use [conditionals](#Conditional_expressions.md). Numbers in an expression may have an optional [unit](#Units.md) attached to them.\n\nNumbers may use either a comma `,` or a decimal point `.` to separate whole digits from decimals. When the decimal marker is used, it *must* be followed by at least one digit. Thus, the expressions `1. + 2.` and `1, + 2,` are invalid, but `1.0 + 2.0` and `1,0 + 2,0` are valid.\n\nOperators and functions are unit-aware, and require valid combinations of units, if supplied. For example, `2mm + 4mm` is a valid expression, while `2mm + 4` is not. This also applies to references to object properties that have units, such as Length properties. Thus `Pad001.Length + 1` is invalid since it adds a pure number to a property with length units, it requires `Pad001.Length + 1mm`.\n\nSome unit related errors can seem unintuitive, with expressions either being rejected or producing results that do not match the units of the property being set. Here are some examples:\n\n\n`1/2mm`\n\nis not interpreted as half a millimeter but as `1/(2mm)`, resulting in: `0.5 mm^-1`.\n\n\n`sqrt(2)mm`\n\nis not valid because the function call is not a number. This has to be entered as `sqrt(2) * 1mm`.\n\n### Function arguments \n\nMultiple arguments to a function may be separated by either a semicolon followed by a space `, `. In the latter case, the comma is converted to a semicolon after entry. When a semicolon is used, no trailing space is necessary.\n\nArguments may include references to cells in a spreadsheet. A cell reference consists of the cell\\'s uppercase row letter followed by its column number, for example `A1`. A cell may also be referenced by using the cell\\'s alias instead, for example `Spreadsheet.MyPartWidth`.\n\n### Referencing objects \n\nAs already shown above, you can reference an object by its **Name**. But you can also use its **Label**. In the case of a **Label**, it must be enclosed in double `<<` and `>>` symbols, such as `<