Download samples/train.jsonl from SlayerLab/english-technical-1b: direct link, hf CLI and curl.
- Browser
- Download file 175 kB
-
https://huggingface.co/datasets/SlayerLab/english-technical-1b/resolve/main/samples/train.jsonl
- Command line
-
hf download hf://datasets/SlayerLab/english-technical-1b/samples/train.jsonl
-
curl -L -o train.jsonl https://huggingface.co/datasets/SlayerLab/english-technical-1b/resolve/main/samples/train.jsonl
175 kB
| {"id": "freecad-docs:wiki/3D_View.md", "text": "# 3D View\n1. REDIRECT [3D view](3D_view.md)\n\n\n---\n⏵ [documentation index](../README.md) > 3D View\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 39, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/3D_input_devices.md", "text": "# 3D input devices\nFreeCAD supports some specialized input devices, such as 3D mice. These enables the user to rotate, translate and zoom objects in three dimensions.\n\n## Supported hardware \n\n- 3Dconnexion [SpaceMouse](https://3dconnexion.com/spacemouse/)\n- Installation instructions: [3D connexion input devices](3Dconnexion_input_devices.md)\n\n [category:Documentation](category_Documentation.md)\n\n\n---\n⏵ [documentation index](../README.md) > 3D input devices\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 111, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/3Dconnexion.md", "text": "# 3Dconnexion\n1. REDIRECT [3Dconnexion_input_devices](3Dconnexion_input_devices.md)\n\n\n---\n⏵ [documentation index](../README.md) > 3Dconnexion\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 43, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/3Dconnexion_input_devices.md", "text": "# <img alt=\"3Dconnexion SpaceNavigator\" src=images/SpaceNavigator.jpg style=\"width:200px;\"> 3Dconnexion input devices\n\n \n\n## Driver installation \n\n### Linux\n\nFreeCAD supports drivers from project [Spacenav](http://spacenav.sourceforge.net/). This is a project aiming to create an open-sourced driver which is compatible with the proprietary drivers from 3Dconnexion.\n\n#### Install from repo \n\n##### Ubuntu\n\n \n```python\nsudo apt-get install spacenavd\n```\n\nNote, however, that version 0.6 available on Ubuntu 20.04 (and probably older ones) does not seem to work. You then have to compile spacenavd from source as explained below.\n\n##### Fedora\n\n \n```python\nsudo yum install spacenavd\n```\n\n##### Debian\n\n \n```python\napt-get install spacenavd libspnav-dev\n```\n\nSpacenav needs these permissions:\n\n\n: \n \n```python\n cp ~/.Xauthority /root/\n \n```\n \n\n\nRestart spnavd and FreeCAD\n\n\n: \n \n```python\n /usr/bin/spnavd_ctl x11 stop\n /usr/bin/spnavd_ctl x11 start\n \n```\n \n\n\n##### openSUSE\n\n \n```python\nsudo zypper install spacenavd\n```\n\n#### Compile Spacenav from source \n\nThis is recommended if your distribution might provide an outdated version.\n\n- Download the following files:\n - [spacenavd](https://sourceforge.net/projects/spacenav/files/latest/download) (latest version)\n - [libspnav](https://sourceforge.net/projects/spacenav/files/spacenav%20library%20%28SDK%29/) (get latest libspnav version)\n - [spnavcfg](https://sourceforge.net/projects/spacenav/files/spacenavd%20config%20gui/) (get latest libspnav version)\n- Unpack the archives into a folder in your home directory.\n- Enter the spacenavd-x.x directory and run the following commands:\n\n\n: \n \n```python\n ./configure\n make\n \n```\n \n- If this was successful, run the following commands **as root** (or prefix with sudo.)\n\n\n: \n \n```python\n make install\n ./setup_init\n /etc/init.d/spacenavd start\n \n```\n \n- This installs the spacenav daemon, configures it to automatically load on system boot, and starts the daemon without having to reboot.\n- Now it is time to check that your device is properly detected. With your device unplugged, run the following command and then plug it in.\n\n\n: \n \n```python\n tail -n100 -f /var/log/spnavd.log \n \n```\n \n- If the output looks something like this, you can continue.\n\n\n: \n \n```python\n Device detection, parsing /proc/bus/input/devices\n trying alternative detection, querying /dev/input/eventX device names...\n trying \"/dev/input/event1\" ... Power Button\n trying \"/dev/input/event2\" ... 3Dconnexion SpaceNavigator\n using device: /dev/input/event2\n device name: 3Dconnexion SpaceNavigator\n \n```\n \n- Now enter the directory named libspnav-x.x.x and run the following commands:\n\n\n: \n \n```python\n ./configure\n make\n \n```\n \n- If make fails with the following error: \\...\n\n\n: \n \n```python\n fatal error: gtk/gtk.h: No such file or directory\n \n```\n \n- \\... then you need to install **libgtkmm-2.4-dev**. Under Ubuntu, this is done like this:\n\n\n: \n \n```python\n sudo apt-get install libgtkmm-2.4-dev\n \n```\n \n- When make has completed successfully, run the following command **as root** (or prefix with sudo.)\n\n\n: \n \n```python\n make install\n \n```\n \n- Look in the directory libspnav-x.x.x/examples/. If you want to test your device, compile and run either one of the two examples.\n\n- Follow the same pattern to compile and install **spnavcfg**. Make sure to run spnavcfg as root, or no settings will be saved!\n\n#### Starting spacenavd as a systemd service at boot \n\nIf you want to start spacenavd at boot using systemd, do the following:\n\n- Go to the directory where you clone the spacenavd repository (to the root of the repository)\n- \\\"sudo cp contrib/systemd/spacenavd.service /usr/lib/systemd/system/spacenavd-local.service\\\".\n- \\\"sudo systemctl enable spacenavd-local.service\\\".\n- \\\"sudo systemctl start spacenavd-local.service\\\", if you want to start it right away.\n\nThis is only necessary for the installation from source.\n\n#### Restarting spacenavd \n\nIf sometimes SpaceNavigator stops working, it is good to restart driver. To restart it, go to Terminal and execute:\n\n \n```python\nsudo xhost +\nsudo /etc/init.d/spacenavd restart\n```\n\nAfter that restart FreeCAD. On some distros this is necessary at each boot.\n\n#### Known Issues \n\nA user reported on the [forum](https://forum.freecadweb.org/viewtopic.php?p=341327#p341327) they saw the following:\n\n Spacenav daemon 0.6\n failed to open config file /etc/spnavrc: No such file or directory. using defaults.\n adding device.\n device name: 3Dconnexion SpacePilot\n using device: /dev/input/event5\n No protocol specified\n failed to open X11 display \":0.0\" \n\nThe workaround that worked for them:\n\n \n```python \nsudo cp ~/.Xauthority /root/\nsudo spnavd_ctl x11 start\nsudo systemctl restart spacenavd \n```\n\n### MacOS\n\n3Dconnexion input devices are supported on macOS, provided FreeCAD is built and used on a system with the 3Dconnexion drivers installed. You may need 3DxWare 10.7.2 or greater for macOS 12 Monterey.\n\n### Windows\n\nAs of version 0.13, 3D mouse is supported under Windows. You need to have 3Dconnexion drivers installed. In FreeCAD version 1.0 a [new integration with 3Dconnexion devices](https://github.com/FreeCAD/FreeCAD/pull/12929) has been introduced. If compiled with that integration, only recent hardware is supported: to support older devices users will need to self-compile with the FREECAD_3DCONNEXION_SUPPORT cMake variable set to \\\"Raw Input\\\". Windows users should be aware that 3Dconnexion\\'s driver (*not* the code in FreeCAD) contains a telemetry package that communicates information about your installed software back to 3Dconnexion.\n\n#### Known Issues \n\n- In FreeCAD version 1.0 and later changing settings in the 3DX config window may not have the expected results ([issue](https://github.com/FreeCAD/FreeCAD/issues/14044)). To fix this:\n 1. Stop the driver (by running Stop 3DxWare).\n 2. Go to **..<user>\\AppData\\Roaming\\3Dconnexion\\3DxWare\\Cfg** and delete the **FreeCAD.xml** file.\n 3. Start the driver (by running Start 3DxWare).\n 4. Run FreeCAD and check if you can change the [Spaceball Motion](#Spaceball_Motion.md) settings.\n\n## Setting up FreeCAD \n\n\n<small>(v1.0)</small> \n\n: The 3Dconnexion manipulator can be set up in its driver app (3DxWare software).\n\n\n{{VersionMinus|0.21}}\n\n: If a Spaceball is detected the following tabs in the [Customize dialog](Interface_Customization.md) can be used to change settings:\n\n <img alt=\"\" src=images/Spaceball_Motion.png style=\"width:450px;\"> <img alt=\"\" src=images/Spaceball_Buttons.png style=\"width:450px;\"> \n\n### Spaceball Motion \n\nIn this tab you have ability to set up some of general space mouse settings. They include:\n\n- Global Sensitivity - Slider with ability to set global sensitivity\n- Dominant - if you enable dominant mode, only axes with highest move will be considered\n- Flip YZ - This option enables you to flip Y and Z axes on 3D mouse\n- Enable Translations - easy way to enable/disable translations\n- Enable Rotations - easy way to enable/disable rotations\n- Calibrate - enables you to calibrate space navigator. It is pressed while space navigator is not moved.\n- Set To Default - removes all settings and sets them to default.\n\nOther than this, for each axes you have ability to set:\n\n- Enabled - Enable/Disable axes\n- Reverse - Reverse movement on axes\n- Sensitivity - slider with ability to set sensitivity\n\n### Spaceball Buttons \n\nWhen you open this tab for the first time, it will be empty and unavailable. To activate it, you must press one of your space mouse buttons. After you do, list of buttons will appear on the left side, and list of commands will be available on the right side.\n\nTo connect certain command with a button, select button on the left side, and it\\'s command on the right side. To clear commands from button, press \\\"Clear\\\".\n\n### Troubleshooting\n\nCheck if your FreeCAD installation links to the spacenav library. The best way to check this is by running FreeCAD from the command line terminal `FreeCAD --log-file /tmp/freecad.log` and close it immediately again. Then open the file **/tmp/freecad.log** and search for the messages:\n\n \n\nor\n\n \n\nIf none of them appears then your FreeCAD build doesn\\'t link to the spacenav library. If the former message appears then it basically works. The latter message means there is probably a problem with the spacenav daemon.\n\n## Related\n\n- Forum thread [spacenav on Windows](https://forum.freecadweb.org/viewtopic.php?f=3&t=51023)\n- Forum thread [Space navigator axis confusion](https://forum.freecadweb.org/viewtopic.php?f=8&t=57188)\n\n\n---\n⏵ [documentation index](../README.md) > [User Documentation](Category_User%20Documentation.md) > [3rd Party](Category_3rd%20Party.md) > 3Dconnexion input devices\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2275, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/A2plus.md", "text": "# A2plus\n1. REDIRECT [A2plus_Workbench](A2plus_Workbench.md)\n\n\n---\n⏵ [documentation index](../README.md) > A2plus\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 41, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/A2plus_Workbench.md", "text": "# <img alt=\"A2plus workbench icon\" src=images/A2p_workbench.svg style=\"width:64px;\"> A2plus Workbench\n\n## Introduction\n\n \n\nThe A2plus workbench is an [external workbench](External_workbenches.md) to [assemble](Assembly.md) different parts in FreeCAD.\n\nThis documentation describes A2plus version **0.4.56 or newer**.\n\n## Installing\n\nThe A2plus workbench is an addon to FreeCAD. It can easily be installed via the FreeCAD <img alt=\"\" src=images/AddonManager.svg style=\"width:24px;\"> [Addon Manager](Std_AddonMgr.md) from the **Tools → Addon Manager** menu. A2plus is under active development and will get new features frequently. Therefore you should update it regularly using also the menu **Tools → [Addon Manager](Std_AddonMgr.md)**. The A2plus code is hosted and developed [on GitHub](https://github.com/kbwbe/A2plus) and can also be installed manually by copying it into FreeCAD\\'s **Mod** directory.\n\n## Getting Started \n\nAt first switch to the A2plus toolbar in FreeCAD. To create an assembly create a new file in FreeCAD. At first this file needs to be saved. It is recommended (but not necessary) to save it in the same folder of the parts you want to assemble.\n\nNow parts can be added to the assembly by using the toolbar button <img alt=\"\" src=images/A2p_ImportPart.svg style=\"width:24px;\"> or <img alt=\"\" src=images/A2p_ShapeReference.svg style=\"width:24px;\">. The button <img alt=\"\" src=images/A2p_ImportPart.svg style=\"width:24px;\"> adds all bodies in the selected file as a single part. When using the button <img alt=\"\" src=images/A2p_ShapeReference.svg style=\"width:24px;\"> you can choose what part from a file should be imported as part. This way one can for example only import a sketch to assemble further parts using the sketch to determine the part positions.\n\nThe first added part gets a fixed position by default. (You can change this later via the part property **fixed Position**.)\n\nParts that are already in the assembly can be cloned with the toolbar button <img alt=\"\" src=images/A2p_DuplicatePart.svg style=\"width:24px;\">.\n\nTo edit a part from the assembly, select it in the model tree and use the toolbar button <img alt=\"\" src=images/A2p_EditPart.svg style=\"width:24px;\">. This will open the part into a new tab in FreeCAD or switch to its tab if the file is already opened.\n\nTo update changed parts in assemblies click on the toolbar button <img alt=\"\" src=images/A2p_ImportPart_Update.svg style=\"width:24px;\">. The toolbar button <img alt=\"\" src=images/A2p_RecursiveUpdate.svg style=\"width:24px;\"> imports parts too but recursively over possible [subassemblies](#Subassemblies.md). If you select one or some parts in FreeCAD\\'s the tree view, A2plus will ask you to only update the selected parts.\n\nImported parts will keep their external dependencies and can be edited. For well-defined parts like screws it is however useful that their shape cannot be edited. This can be achieved with the toolbar button <img alt=\"\" src=images/A2p_ConvertPart.svg style=\"width:24px;\"> that converts the selected part to a static copy of the original part.\n\nTo save the assembly and close it afterwards, the toolbar button <img alt=\"\" src=images/A2p_Save_and_exit.svg style=\"width:24px;\"> can be used.\n\nToggling the toolbar button <img alt=\"\" src=images/A2p_CD_OneButton.svg style=\"width:24px;\"> sets the way you can select several several edges, faces etc.: Either with a single click or by **Ctrl**+click.\n\n## Assembling\n\nAssembling parts is done by adding constraints between parts. After a constraint A2plus will move the parts according to the constraint if possible.\n\nTo create a constraint between parts, keep the **Ctrl** key pressed and select each an edge or face of two parts. Then click the toolbar button of the desired constraint. A dialog will pop up that is descried in section [Constraints](#Constraints.md). The constraint will be added in the model tree attached to the affected parts.\n\nFor complex constraints between parts A2plus might fail to solve the constraints. Therefore also have a look at section [Troubleshooting](#Troubleshooting.md) for strategies to resolve such cases.\n\n### Keeping track \n\nThe more parts you add, the more important it is to keep track. A2plus therefore offers these tools to move and view parts:\n\n- To move a part around in the assembly, select it in the model tree and use the toolbar button <img alt=\"\" src=images/A2p_MovePart.svg style=\"width:24px;\">. When you placed the part where you like it, left-click with the mouse. If the moved part already has constraints it will be placed accordingly by pressing the toolbar button <img alt=\"\" src=images/A2p_solver.svg style=\"width:24px;\"> because this triggers to resolve all constraints of the assembly.\n- To show a constraint select it in the model tree and use the toolbar button <img alt=\"\" src=images/A2p_ViewConnection.svg style=\"width:24px;\">. This will make the whole assembly transparent and highlight the two objects that are connected via the constraint. To go back to the normal view, left-click into the assembly.\n- To show only certain parts in the assembly, select these parts in the model tree and use the toolbar button <img alt=\"\" src=images/A2p_Isolate_Element.svg style=\"width:24px;\">. Alternatively you can hide a certain part by selecting it in the model tree and pressing **Space** to toggle its visibility.\n- To toggle the transparency view of the whole assembly you can use the toolbar button <img alt=\"\" src=images/A2p_ToggleTransparency.svg style=\"width:24px;\">.\n- Every part can be made transparent using the normal FreeCAD editing. However sometimes the transparency setting for parts is lost when reopening the assembly due to a bug in FreeCAD. As workaround you can use the toolbar button <img alt=\"\" src=images/A2p_Restore_Transparency.svg style=\"width:24px;\"> to restore the transparency settings.\n\n### Constraints\n\nWhen creating a constraint such a dialog will be displayed after you pressed a constraint toolbar button:\n\n  \n*Above: The A2plus Constraint Properties Dialog*\n\nFor certain constraints it allows you to modify the constraint direction. With the button **<img src=\"images/A2p_solver.svg\" width=24px> Solve** you can check beforehand if this new constraint can be solved by A2plus. If not, have a look at section [Troubleshooting](#Troubleshooting.md).\n\nConstraints can be disabled by changing its [visibility](Std_ToggleVisibility.md). This is done by selecting the constraint in the tree view and pressing **Space**. This toggles the property **Suppressed**. A suppressed constraint is not taken into account when the assembly is solved.\n\nA2plus provides the following constraints:\n\n#### Point on Point \n\nSelect either a [vertex](Glossary#Vertex.md) (point), circle or sphere on each part. If a circle or sphere was selected, its center point will be used for the constraint. The toolbar button <img alt=\"\" src=images/A2p_PointIdentity.svg style=\"width:24px;\"> adds the constraint {{Variable|pointIdentity}} that make the vertices coincident.\n\n#### Point on Line \n\nSelect a [vertex](Glossary#Vertex.md) (point), or circular [edge](Glossary#Edge.md) (will select its center point), or a spherical [face](Glossary#Face.md) (will also select its center point) on one part and an [edge](Glossary#Edge.md) on the other part. The toolbar button <img alt=\"\" src=images/A2p_PointOnLineConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|pointOnLine}}. It will put the vertex on the edge.\n\n#### Point on Plane \n\nSelect a [vertex](Glossary#Vertex.md) (point), or circular [edge](Glossary#Edge.md) (will select its center point), or a spherical [face](Glossary#Face.md) (will also select its center point) on one part and a plane on the other part. The toolbar button <img alt=\"\" src=images/A2p_PointOnPlaneConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|pointOnPlane}}. The constraint dialog allows you to specify an offset between the point and the plane. This offset can also be flipped between both sides of the plane. If the offset is zero, the constraint will put the vertex on the plane.\n\n#### Sphere on Sphere \n\nSelect either a spherical [face](Glossary#Face.md) or a [vertex](Glossary#Vertex.md) (point) on both parts. The toolbar button <img alt=\"\" src=images/A2p_SphericalSurfaceConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|sphereCenterIdent}}. It will either make the center of the spheres, the center of the sphere and the vertex, or the vertices coincident.\n\n#### Circular Edge on Circular Edge \n\nSelect a circular [edge](Glossary#Edge.md) on both parts. The toolbar button <img alt=\"\" src=images/A2p_CircularEdgeConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|circularEdge}}. The constraint dialog allows you to specify an offset between the edges. This offset can also be flipped. You can furthermore set the constraint direction and lock the rotation of the parts. If the offset is zero, the constraint will put the edges concentric in the same plane.\n\n#### Axis Coincident \n\nSelect either a cylindrical [face](Glossary#Face.md) or a linear [edge](Glossary#Edge.md) on both parts. The toolbar button <img alt=\"\" src=images/A2p_AxialConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|axisCoincident}}. The constraint dialog allows you to specify the axis direction. The dialog allows you furthermore to lock the rotation of the parts. The constraint will make the axes or lines coincident.\n\n#### Axis Parallel \n\nSelect either a cylindrical [face](Glossary#Face.md) or a linear [edge](Glossary#Edge.md) on both parts. The toolbar button <img alt=\"\" src=images/A2p_AxisParallelConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|axisParallel}}. The constraint dialog allows you to specify the axis direction. The constraint will make the axes or lines parallel.\n\n#### Axis on Plane parallel \n\nSelect either a cylindrical [face](Glossary#Face.md) or a linear [edge](Glossary#Edge.md) on one part and a plane on the other part. The toolbar button <img alt=\"\" src=images/A2p_AxisPlaneParallelConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|axisPlaneParallel}}. The constraint will make the axis or line parallel to the plane.\n\n#### Axis on Plane normal \n\nSelect either a cylindrical [face](Glossary#Face.md) or a linear [edge](Glossary#Edge.md) on one part and a plane on the other part. The toolbar button <img alt=\"\" src=images/A2p_AxisPlaneNormalConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|axisPlaneNormal}}. The constraint will make the axis or line normal to the plane.\n\n#### Axis on Plane angle \n\nSelect either a cylindrical [face](Glossary#Face.md) or a linear [edge](Glossary#Edge.md) on one part and a plane on the other part. The toolbar button <img alt=\"\" src=images/A2p_AxisPlaneAngleConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|axisPlaneAngle}}. The constraint will at first make the axis parallel to the plane. Then you can adjust the angle for the axis in the appearing constraint settings dialog.\n\n#### Plane Parallel \n\nSelect a plane on both parts. The toolbar button <img alt=\"\" src=images/A2p_PlanesParallelConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|planesParallel}}. The constraint dialog allows you to specify the constraint direction. The constraint will make the planes parallel.\n\n#### Plane on Plane \n\nSelect a plane on both parts. The toolbar button <img alt=\"\" src=images/A2p_PlaneCoincidentConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|planeCoincident}}. The constraint dialog allows you to specify a constraint direction and an offset between the planes. This offset can also be flipped. If the offset is zero, the constraint will make the planes coincident.\n\n#### Plane Angular \n\nSelect a plane on both parts. The toolbar button <img alt=\"\" src=images/A2p_AngleConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|angledPlanes}}. The constraint dialog allows you to specify an angle between the planes. The constraint will make the planes at first parallel and the set the specified angle.\n\n#### Coincidence at Center of Mass \n\nSelect either a closed [edge](Glossary#Edge.md) or a plane on both parts. The toolbar button <img alt=\"\" src=images/A2p_CenterOfMassConstraint.svg style=\"width:24px;\"> adds the constraint {{Variable|centerOfMass}}. The constraint dialog allows you to specify an offset between the edges or planes. This offset can also be flipped. You can furthermore set the constraint direction and lock the rotation of the parts. If the offset is zero, the constraint will put the edges or planes into the same plane.\n\n### Subassemblies\n\nAn assembly can contain other assemblies. They are added like parts by pressing the toolbar button <img alt=\"\" src=images/A2p_ImportPart.svg style=\"width:24px;\"> and selecting a ***.FCStd** file containing an assembly. Such subassemblies can also be edited like parts using the toolbar button <img alt=\"\" src=images/A2p_EditPart.svg style=\"width:24px;\">. Please make sure for higher assembly stages that you update the assembly recursively via the toolbar button <img alt=\"\" src=images/A2p_RecursiveUpdate.svg style=\"width:24px;\"> when there were changes.\n\n## Constraint Handling \n\nPossible constraints for a selection are displayed in the toolbar and the *Constraint Tools* dialog by enabling the corresponding buttons. The *Constraint Tools* dialog is opened via the toolbar button <img alt=\"\" src=images/A2p_DefineConstraints.svg style=\"width:24px;\">. It is intended to stay open to be able to add quickly several constraints to the assembly.\n\nExisting constraints can be edited by selecting them in the model tree and then either double-clicking on it or using the toolbar button <img alt=\"\" src=images/A2p_EditConstraint.svg style=\"width:24px;\">. This opens the *Constraint Properties* dialog.\n\nConstraints can be temporarily suppressed by selecting them in the model tree and changing the tree element property **Suppressed**.\n\nConstraints can be deleted either by selecting them in the model tree and pressing **Del** or by selecting a part with constraints in the model tree and using the toolbar button <img alt=\"\" src=images/A2p_DeleteConnections.svg style=\"width:24px;\">.\n\nAll constraints can be resolved at any time with the toolbar button <img alt=\"\" src=images/A2p_solver.svg style=\"width:24px;\">. If the toolbar button <img alt=\"\" src=images/A2p_ToggleAutoSolve.svg style=\"width:24px;\"> is turned on a resolve is automatically done after every edit of a constraint.\n\nThe toolbar button <img alt=\"\" src=images/A2p_FlipConstraint.svg style=\"width:24px;\"> affects the constraint that was added most recently. It flips the constraint direction.\n\nWith the <img alt=\"\" src=images/A2p_CD_ConstraintViewer.svg style=\"width:24px;\"> tool, it is possible the show and inspect existing constraints. After clicking it a dialog pops up. Then either select a part in the tree and click the button **Import from part** to get all constraints of this part, or select one or more constraints in the tree and click the button **Import from Tree**. As result you get all info about the constraints. By clicking in the column *Suppress* a single constraint can be suppressed. For more features, follow the tooltips of the other dialog buttons.\n\n## Part Lists \n\nTo create part lists of assemblies, the different parts of the assembly must get part info that can be read by A2plus. This is done by editing the part using the toolbar button <img alt=\"\" src=images/A2p_EditPart.svg style=\"width:24px;\">. In the opened part press the toolbar button <img alt=\"\" src=images/A2p_PartsInfo.svg style=\"width:24px;\"> and a [spreadsheet](Spreadsheet_Workbench.md) with the name *#PARTINFO#* is created.\n\nThe structure of the spreadsheet is like this:\n\n\n\nFill out the grey fields with info you have and want to have in the final parts list.\n\nIn the assembly or subassembly use the toolbar button <img alt=\"\" src=images/A2p_PartsList.svg style=\"width:24px;\">. It will ask you if you want to iterate recursively over all subassemblies. Click on *Yes*. This creates a new spreadsheet with the name *#PARTSLIST#*. It contains the info from the different *#PARTSINFO#* spreadsheets of the parts in a list like this:\n\n\n\nThe position (POS) is automatically set according to the appearance of the parts in the model tree. The top level part will get POS 1.\n\nThe quantity (QTY) is automatically calculated from the assembly. If a parts is twice in the assembly it will get QTY 2.\n\nIf you have updated a part info you can refresh the parts list by pressing the toolbar button <img alt=\"\" src=images/A2p_PartsList.svg style=\"width:24px;\"> again.\n\nFor subassemblies you can also create an info spreadsheet using the toolbar button <img alt=\"\" src=images/A2p_PartsInfo.svg style=\"width:24px;\">. When you create or update the parts list of the main assembly this info will be used if you click on *No* for the question if you want to iterate recursively over all subassemblies. Then the different parts are not in the parts list but only the subassemblies.\n\n## Special Features \n\n### Assembly Structure \n\nThe toolbar button <img alt=\"\" src=images/A2p_Treeview.svg style=\"width:24px;\"> creates an HTML file with the structure of your assembly. The file will by default be created in the folder of your assembly file. The structure looks like this:\n\n: \n\n### Degrees of Freedom \n\nThe button <img alt=\"\" src=images/A2p_DOFs.svg style=\"width:24px;\"> labels every part of the assembly with its degrees of freedom. Furthermore it outputs a list with all parts and their dependencies. The list is output into FreeCAD\\'s widget *Report view*. If this widget is currently not visible, it can either be shown by right-clicking into an empty part of the FreeCAD toolbar area and then choosing it in the appearing context menu or with the menu **View → Panels → [Report view](Report_view.md)**.\n\nThe degrees of freedom labels can be removed by clicking the button <img alt=\"\" src=images/A2p_DOFs.svg style=\"width:24px;\"> again.\n\n### Part Labels \n\nThe button <img alt=\"\" src=images/A2p_PartLabel.svg style=\"width:24px;\"> labels every part of the assembly in the 3D view with its name. The part labels can be removed by clicking the button <img alt=\"\" src=images/A2p_PartLabel.svg style=\"width:24px;\"> again\n\n### Shape of whole Assembly \n\nSometimes it is necessary to have the whole assembly combined as one shape. This shape can then for example be used for 3D printing in the [Mesh workbench](Mesh_Workbench.md) or for drawings in the [TechDraw workbench](TechDraw_Workbench.md). It is created using the toolbar button <img alt=\"\" src=images/A2p_SimpleAssemblyShape.svg style=\"width:24px;\">. The shape is by default not made visible. Use the same toolbar button to update the shape in case of changes in the assembly.\n\n### Convert absolute Paths to relative Ones \n\nWith the menu **A2plus → Misc → [<img src=images/A2p_SetRelativePathes.svg style=\"width:24px\"> Convert absolute paths of imported parts to relative ones** you can convert absolute paths of imported parts to relative ones.\n\n## Preferences\n\nThe a2plus preferences can be accessed via FreeCAD\\'s menu **Edit → [Preferences](Preferences_Editor.md)** and there in the section *A2plus*. You can set the following options:\n\n### Default solving method \n\nUse solving of partial systems : The solver begins with a part that has the property **fixed Position** set to *true* and a part constrained to it. All other parts are not calculated. If a solution could be found, the next constrained part is added to the calculation and so on.\nUse \\\"magnetic\\\" solver, solving all parts at once : The solver tries to move all parts at once in direction to a part that has the property **fixed Position** set to *true*. Note that this will in most cases take more time for the calculation of a solution.\nForce fixed position : This sets the property **fixed Position** to *true* for all parts in the assembly. Then no calculation is actually performed since all parts will always be fixed to the positions where they were created.\n\n### Default solver behaviour \n\nSolve automatically if a constraint property is changed : The solver will automatically be started. The same as turning on the toolbar button <img alt=\"\" src=images/A2p_ToggleAutoSolve.svg style=\"width:24px;\">.\n\n### Behaviour when updating imported parts \n\nRecalculate imported parts before updating them : All parts of the assembly, including subassemblies, will be opened in FreeCAD to be reconstructed using values from spreadsheets.\nThis feature is designed to construct fully parametrically. **Note:** This feature is very experimental and not recommended for important projects.\nKnown problems:\n\n- The assembly can be destroyed because of wrong references to topological names in parts\n- Master spreadsheets can get broken when they are edited while a referenced part file is already closed. This can crash FreeCAD.\n\nEnable recursive update of imported parts : Opens all subassemblies recursively to update them.\n\n\nUse experimental topological naming : While importing parts to the assembly an algorithm generates topological names for each subelement of the imported shape. The topological names are written into the **mux Info**. When an imported part needs to be updated, these topological names are used to update the subelements of the constraints. So assemblies get more robust against volatile subelement numbers of FreeCAD.\n**Note:** This increases file sizes and calculation time during import of parts. If topological naming should be used it has to be activated before the assembly is created.\n\n\nInherit per face transparency from parts and subassemblies : Use colour and transparency settings from imported parts.\n**Note:** This feature is very experimental and not recommended for important projects.\n\n\nDo not import invisible shapes : This will hide invisible datum/construction shapes. **Note:** No constraints must be connected to datum/construction shapes in higher or other subassemblies. Otherwise you can break the assembly.\n\n\nUse solid union for importing parts and subassemblies : All imported parts will directly be put together as union.\nThis feature is useful for [FEM](FEM_Workbench.md) simulations or [3D-printing](Manual_Preparing_models_for_3D_printing.md) if only one solid is allowed. The alternative is to create a [shape of the whole assembly](#Shape_of_whole_Assembly.md) later on.\n\n### User interface settings \n\nShow constraints in toolbar : If this option is not used, the toolbar buttons for the different constraints are not visible to save space in the toolbar. New constraints can still be set using the *Constraint Tools* dialog (toolbar button <img alt=\"\" src=images/A2p_DefineConstraints.svg style=\"width:24px;\">).\nUse native file manager of your OS : If this option is used, you get the file dialog of your OS when selecting files for assemblies.\n\n### Storage of files \n\nUse relative paths for imported parts : Uses relative file paths to the part files.\nUse absolute paths for imported parts : Uses absolute file paths to the part files.\nAll files are in this project folder : All project files have to be in the specified folder. It doesn\\'t matter if they are in subfolders of this folder. **Note:** No file is allowed to exist several times in the folder (e.g. in different subfolders).\nThis option is helpful to work on different machines because then one only has to copy the project folder.\n\n## Troubleshooting\n\nSooner or later you will get the problem that A2plus cannot solve the constraints you set. To overcome this, there are different strategies:\n\n### Using the Conflict Finder Tool \n\nThis is the safest method when you have several constraints because this tool attempts to solve one constraint after another until it finds the conflicting constraint. Then you can go on with the other strategies to resolve the identified constraint. The tool is called using the toolbar button <img alt=\"\" src=images/A2p_SearchConstraintConflicts.svg style=\"width:24px;\">.\n\n### Checking Constraint Direction \n\nSometimes constraints seem to be consistently defined but they can nevertheless not be solved. An example: Assume you have a {{Variable|[planesParallel](#Plane_Parallel.md)}} constraint set for two planes. Now you want to set for the same planes the {{Variable|[planeCoincident](#Plane_on_Plane.md)}} constraint and A2plus cannot solve this. Then the constraint directions of {{Variable|planesParallel}} and {{Variable|planeCoincident}} are different. Use the same direction for both constraints to fix this.\n\nA2plus offers to automatically check the right direction for **all** constraints of the assembly using the toolbar button <img alt=\"\" src=images/A2p_ReAdjustConstraints.svg style=\"width:24px;\">.\n\n### Deleting Constraints \n\nMost cases of unsolvable constraints occur directly when adding a new constraint. The solution is then to delete the constraint you added last. A2plus will propose this, too.\n\nSometimes the deletion strategy is the only one, for example when you edited a part in FreeCAD so that faces or edges connected to constraints are missing. You should then delete one constraint that is connected to the changed part at a time. Use the toolbar button <img alt=\"\" src=images/A2p_solver.svg style=\"width:24px;\"> after every deletion to see if you reached a solvable state.\n\nWhen you got an assembly that can be solved, add step by step the constraints you need.\n\n### Moving Parts \n\nIn some cases the solver only needs better start values to solve the constraints. Take for example the case that you have an axle part and a wheel part. You add a {{Variable|axisCoincident }} constraint and get no info that the solver failed but the parts are not moved accordingly and in the *Report view* widget of FreeCAD you see \\\"*REACHED POS-ACCURACY :0.0*\\\". A solution for this is to move the parts closer to that position you like to get by the constraint.\n\n**Note:** Assure that at least one part of the constraint has the property **fixed Position** set to *false*.\n\n### Setting the Tip Property \n\nIf you miss some features of your part after the import to an A2plus assembly, check the property **[Tip](PartDesign_MoveTip.md)**.\n\nA2plus imports bodies of parts with all their features up to the tip feature. This is sensible because setting the tip to a certain feature means that all features behind the tip should not appear in the final part. So if you miss a part feature in A2plus, open the part via the toolbar button <img alt=\"\" src=images/A2p_EditPart.svg style=\"width:24px;\">, then select a body and look at its property **Tip**. If the tip is not at the feature where you want it, right-click on the feature where the tip should be and choose **[<img src=images/PartDesign_MoveTip.svg style=\"width:24px\"> Set tip**. Finally save the part and reload the assembly using the toolbar button <img alt=\"\" src=images/A2p_ImportPart_Update.svg style=\"width:24px;\">.\n\n### Repairing Assembly Tree \n\nIf you cannot see a clear reason why some constraints cannot be resolved, you can try to use the toolbar button <img alt=\"\" src=images/A2p_RepairTree.svg style=\"width:24px;\">. This will resolve all constraints and re-group then again under the different parts.\n\n### Migrating old A2plus assemblies \n\nAssemblies created with A2plus older than March 2019 do not show the correct icons for imported parts and have obsolete properties. These assemblies can be migrated to A2plus version 0.4.35 and newer using the menu **A2plus → Misc → [<img src=images/A2p_Upgrade.svg style=\"width:24px\"> Migrate proxies of imported parts**. After doing this, you must save and reopen your assembly file.\n\n### Avoiding Accented Characters \n\n**This strategy is not necessary for Windows.**\n\nOn some operating systems you can get problems if the file names or the file paths of parts or the assembly contain accented characters. Therefore avoid such characters and also special characters in general.\n\n### Fixing Position \n\n**This strategy is no longer necessary for assemblies created with A2plus 0.3.11 or newer because A2plus issues now a warning for missing fixed positions.**\n\nWhen you set a constraint between two parts and no part has the property **fixed Position** set to *true* or is connected by a constraint to a part with **fixed Position** set to *true*, the constraint cannot be solved. The same happens if both parts of the constraint have **fixed Position** set to *true*.\n\nThen A2plus outputs the info about the failed solution, but sometimes you only see that the parts are not moved accordingly and in the *Report view* widget of FreeCAD you see \\\"*REACHED POS-ACCURACY :0.0*\\\". This means the solver finished without errors but it could actually not solve the constraints.\n\nTherefore check that at least one of your parts in the assembly has **fixed Position** set to *true*. Then assure that you only set constraints to a part which is somehow connected to the fixed part. To visualise these dependencies, see section [Assembly Structure](#Assembly_Structure.md).\n\n### Rotating Parts \n\n**This strategy is no longer necessary for assemblies created with A2plus 0.4.0 or newer because A2plus rotates the parts now automatically a bit in the background to get a sufficient start angle for the solver.**\n\nThe solver often fails for the constraint {{Variable|angledPlanes}} if the two selected planes have currently an angle of 0° or 180°. (The parts are not moved accordingly and in the *Report view* widget of FreeCAD you see \\\"*REACHED POS-ACCURACY :0.0*\\\".) A solution for this is to rotate one part by a few degrees using FreeCAD\\'s transform feature (right-click on the part in the model tree and select in the context menu **Transform**).\n\n**Note:** Assure that at least one part of the constraint has the property **fixed Position** set to *false*.\n\n## Animation\n\nA2plus offers animations via dragging and via Python scripts.\n\n### Dragging\n\nDragging animations are interactive since you trigger it by dragging a part of the assembly. To get these kind of animations:\n\n1. Fully constrain the part whose movement or rotation should be animated\n2. Click on the toolbar button <img alt=\"\" src=images/A2p_MovePartUnderConstraints.svg style=\"width:24px;\">. This enables the dragging mode.\n3. Click on the desired part in the assembly.\n4. Now you can move the mouse and the part will follow the movement of the mouse within the defined constraints.\n5. To end the dragging mode, left click in the assembly or press ESC.\n\nHere is an example assembly to try out the dragging animation: [A2p_example-for-dragging-animation.FCStd](https://forum.freecadweb.org/download/file.php?id=99204)\n\n\n\n\n*Above: The dragging animation using the example assembly*\n\n### Scripting\n\nDespite the dragging mode offers nice interactive animations, they are sometimes not precise enough for screencasts or videos. Scripted animations have the advantage that they animate movements and rotations in a defined way. You can for example rotate a part by exactly 10° back and forth. The following examples use an assembly where a part should be rotated. If you try to animate this using the dragging mode, you will see how hard it is to get a back and forth rotation that you can e.g. show your boss in a presentation. With the interactive example script, however, this is an easy task.\n\nA scripted animation works usually this way:\n\n1. The assembly is fully constrained\n2. The script changes a parameter, for example the position or rotation angle of a part\n3. After the parameter change, the assembly constraints are solved\n4. Step 2. and 3. are repeated to get the animation\n\nIt is also possible to change instead of a placement parameter a constraint, for example the distance between 2 planes.\n\n#### Simple Script Example \n\nThe simplest way to script an animation is a non-interactive animation that follows a defined movement. Here is an example: First download this assembly file: [A2p_animated-example.FCStd](https://forum.freecadweb.org/download/file.php?id=97554) and also this Python script: [A2p_animation-example-script.py](https://forum.freecadweb.org/download/file.php?id=97981).\n\n\n<div class=\"mw-collapsible mw-collapsed toccolours\">\n\n This is the content of the script and the lines beginning with a \\'#\\' describe what the different script lines do: \n\n\n<div class=\"mw-collapsible-content\">\n\n \n```python\n# import libraries\nimport time, math, PySide\nimport A2plus.a2p_solversystem as a2p_solver\n\n\n# we use steps of 1 degree\nstep = 1\n# wait 1 ms between every step\ntimeout = 0.001\n# initial angle is 0 degree\nangle = 0\n# we take the currently opened document\ndocument = FreeCAD.activeDocument()\n# we want later change the rotation angle of the part \"star_wheel_001\"\nstarWheel = document.getObject(\"star_wheel_001\")\n# define a progress dialog running from 0 to 360\nprogressDialog = PySide.QtGui.QProgressDialog(u\"Animation progress\", u\"Stop\", 0, 360)\n\n\n# the while block is the main loop to change the angle and solve\n# the assembly constraints subsequently\nwhile angle < 360: # run this loop until we have one full turn (360 degrees)\n # increase the rotation angle\n angle += step\n # set the new angle to the progress dialog\n progressDialog.setValue(angle)\n # change the rotation angle of the part \"star_wheel_001\"\n starWheel.Placement.Rotation.Angle = math.radians(angle)\n # solve the constraints \n a2p_solver.solveConstraints(document, useTransaction=True)\n # update the view after the solving ('Gui' stands for 'graphical user interface')\n FreeCADGui.updateGui()\n # bring the progress dialog to front\n PySide.QtGui.QWidget.raise_(progressDialog)\n # if 'Stop' was pressed in the dialog, exit the loop\n if progressDialog.wasCanceled():\n angle = 360\n # wait some time before performing the next step\n time.sleep(timeout)\n```\n\n\n</div>\n\n\n</div>\n\n\nTo use the script to perform the animation, we must\n\n1. Open the assembly file in FreeCAD.\n2. Open the script file in FreeCAD.\n3. Click on the toolbar button <img alt=\"\" src=images/Menu_Std_DlgMacroExecute_fr_02.png style=\"width:24px;\"> to execute the script (also called macro).\n4. Change to the tab of the assembly to see the rotation.\n\nTo practice, just change something in the script and execute it afterwards. For example increase *step* to *5*.\n\nThis is the result of the example animation:\n\n\n\n#### Interactive Script Example \n\nThe first script example demonstrated how to create an animation without any user feedback. For most applications you need to interact with the animation. For example the interesting issue in the example is to see how the driving pins cross the center groove of the wheel. To have a closer look you might present this detail to your colleagues or boss. Therefore you need an interactive solution.\n\nThis can be done by using a custom animation dialog with a slider. By moving the slider you can set the rotation angle and therefore rotate back and forth at interesting position.\n\nWe use the same assembly file: [A2p_animated-example.FCStd](https://forum.freecadweb.org/download/file.php?id=97554) and this Python script: [A2p_animation-example-script.py](https://forum.freecadweb.org/download/file.php?id=97982).\n\n\n<div class=\"mw-collapsible mw-collapsed toccolours\">\n\n This is the content of the script to get the interactive animation dialog: \n\n\n<div class=\"mw-collapsible-content\">\n\n \n```python\n# import libraries\nimport time, math, PySide, sys\nimport FreeCAD.A2plus.a2p_solversystem as a2p_solver\nfrom FreeCAD import Units\nfrom PySide import QtCore, QtGui\n\n\n# wait 1 ms after every calculation\ntimeout = 0.001\n# we take the currently opened document\ndocument = FreeCAD.activeDocument()\n# we want later change the rotation angle of the part \"star_wheel_001\"\nstarWheel = document.getObject(\"star_wheel_001\")\n\n\nclass AnimationDlg(QtGui.QWidget): # the animation dialog\n\n \ndef __init__(self): # to initialize the dialog\n super(AnimationDlg, self).__init__()\n self.initUI()\n\n \ndef initUI(self): # the definition of the dialog components\n self.setMinimumSize(self.minimumSizeHint()) # set the minimal dialog size to minimum\n self.setWindowTitle('Animation Dialog')\n # use a grid layout for the whole form\n self.mainLayout = QtGui.QGridLayout()\n self.lineNo = 0 # first dialog grid line\n # add description label\n DescriptionLabel = QtGui.QLabel(self)\n DescriptionLabel.setText(\"Change slider to change rotation angle\")\n self.mainLayout.addWidget(DescriptionLabel,self.lineNo,0,1,4)\n # next dialog grid line\n self.lineNo += 1\n # add a label; there is no need for the \"self.\" prefix because we don't want to change the label later\n LabelMin = QtGui.QLabel(self)\n LabelMin.setText(\"Min\")\n LabelMin.setFixedHeight(32)\n self.mainLayout.addWidget(LabelMin,self.lineNo,0)\n # add a spin edit to define the slider minimum\n self.MinEdit = QtGui.QSpinBox(self)\n # get the angle unit as string\n self.MinEdit.setSuffix(\" \" + str(FreeCAD.Units.Quantity(1, FreeCAD.Units.Angle))[2:])\n self.MinEdit.setMaximum(999)\n self.MinEdit.setMinimum(0)\n self.MinEdit.setSingleStep(10)\n self.MinEdit.setValue(0)\n self.MinEdit.setFixedHeight(32)\n self.MinEdit.setToolTip(\"Minimal angle for the slider\")\n QtCore.QObject.connect(self.MinEdit, QtCore.SIGNAL(\"valueChanged(int)\"), self.setMinEdit)\n self.mainLayout.addWidget(self.MinEdit,self.lineNo,1)\n # add the slider\n self.slider = QtGui.QSlider(QtCore.Qt.Horizontal, self)\n self.slider.setRange(0, 360)\n self.slider.setValue(0)\n self.slider.setFixedHeight(32)\n self.slider.setToolTip(\"Move the slider to change the rotation angle\")\n QtCore.QObject.connect(self.slider, QtCore.SIGNAL(\"sliderMoved(int)\"), self.handleSliderValue)\n self.mainLayout.addWidget(self.slider,self.lineNo,2)\n # add a label\n LabelMax = QtGui.QLabel(self)\n LabelMax.setText(\"Max\")\n LabelMax.setFixedHeight(32)\n self.mainLayout.addWidget(LabelMax,self.lineNo,3)\n # add a spin edit to define the slider maximum\n self.MaxEdit = QtGui.QSpinBox(self)\n # get the angle unit as string\n self.MaxEdit.setSuffix(\" \" + str(FreeCAD.Units.Quantity(1, FreeCAD.Units.Angle))[2:])\n self.MaxEdit.setMaximum(999)\n self.MaxEdit.setMinimum(1)\n self.MaxEdit.setSingleStep(10)\n self.MaxEdit.setValue(360)\n self.MaxEdit.setFixedHeight(32)\n self.MaxEdit.setToolTip(\"Maximal angle for the slider\")\n QtCore.QObject.connect(self.MaxEdit, QtCore.SIGNAL(\"valueChanged(int)\"), self.setMaxEdit)\n self.mainLayout.addWidget(self.MaxEdit,self.lineNo,4)\n # next dialog grid line\n self.lineNo += 1\n # add a spacer\n self.mainLayout.addItem(QtGui.QSpacerItem(10,10), 0, 0)\n # add a label\n LabelCurrent = QtGui.QLabel(self)\n LabelCurrent.setText(\"Current angle:\")\n LabelCurrent.setFixedHeight(32)\n self.mainLayout.addWidget(LabelCurrent,self.lineNo,1)\n # output the current angle\n self.CurrentAngle = QtGui.QLineEdit(self)\n self.CurrentAngle.setText(str(0))\n self.CurrentAngle.setFixedHeight(32)\n self.CurrentAngle.setToolTip(\"Current rotation angle\")\n self.CurrentAngle.isReadOnly()\n self.mainLayout.addWidget(self.CurrentAngle,self.lineNo,2)\n # add label for the unit\n LabelUnit = QtGui.QLabel(self)\n LabelUnit.setText(\"deg\")\n LabelUnit.setFixedHeight(32)\n self.mainLayout.addWidget(LabelUnit,self.lineNo,3)\n # button to close the dialog\n self.Close = QtGui.QPushButton(self)\n self.Close.setText(\"Close\")\n self.Close.setFixedHeight(32)\n self.Close.setToolTip(\"Closes the dialog\")\n QtCore.QObject.connect(self.Close, QtCore.SIGNAL(\"clicked()\"), self.CloseClicked)\n self.mainLayout.addWidget(self.Close,self.lineNo,4)\n # place the defined grid layout to the dialog\n self.setLayout(self.mainLayout)\n self.update()\n\n \ndef handleSliderValue(self):\n # set slider value as angle\n starWheel.Placement.Rotation.Angle = math.radians(self.slider.value())\n # output current angle\n self.CurrentAngle.setText(str(self.slider.value()))\n # solve the constraints \n a2p_solver.solveConstraints(document)\n # update the view after the solving ('Gui' stands for 'graphical user interface')\n FreeCADGui.updateGui()\n # wait some time, important to give time to perform calculations\n time.sleep(timeout)\n\n \ndef setMinEdit(self):\n # assure that the minimum is samller than the maximum\n if self.MinEdit.value() >= self.MaxEdit.value():\n self.MaxEdit.setValue(self.MinEdit.value() + 1)\n self.slider.setRange(self.MinEdit.value(), self.MaxEdit.value())\n\n \ndef setMaxEdit(self):\n # assure that the minimum is samller than the maximum\n if self.MinEdit.value() >= self.MaxEdit.value():\n self.MinEdit.setValue(self.MaxEdit.value() - 1)\n self.slider.setRange(self.MinEdit.value(), self.MaxEdit.value())\n\n \ndef CloseClicked(self):\n AnimationDialog.close()\n\n\n# create and show the defined dialog\nAnimationDialog = AnimationDlg()\nAnimationDialog.show()\n\n\n# run this loop when the dialog is visible\nwhile AnimationDialog.isVisible():\n # update the view; important to give the OS feedback the dialog is alive\n FreeCADGui.updateGui()\n # bring the dialog to front, so that the dialog is always visible\n QtGui.QWidget.raise_(AnimationDialog)\n # output slider value here too because during the calculation the slider might have been moved\n AnimationDialog.CurrentAngle.setText(str(AnimationDialog.slider.value()))\n```\n\n\n</div>\n\n\n</div>\n\n\nThe dialog defined in the script looks like this:\n\n\n\n### Script Commands \n\nTo understand the script syntax better, here is some command info:\n\n\nHere we change the placement property `Rotation.Angle` of the part get got previously as `starWheel`. This property gets the angle as [radian](https://en.wikipedia.org/wiki/Radian). The function `radians()` from the library `math` converts the angle from degree to radian.\n\nThe property `Rotation.Angle` uses the current placement axis of the part (in our example the X-axis). To rotate the part e.g. around the Z-axis one can set the rotation axis (before calling the rotation command) using the command:\n\n\nInstead of rotating, parts can also be moved. To change for example the placement in Y-direction of the wheel, the command would be:\n\n\nIn this case we would not define the variable `angle` but `PositionShift` that we change on every loop run.\n\nThere are different ways to set the placement of a part. Some are [ documented here](Placement.md). Unfortunately there is no list (yet) with all possible placement commands.\n\n\nThis is an A2plus-specific command. It solves the assembly constraints of the assembly we previously got as `document`. The option `useTransaction` specifies if FreeCAD should store every change in the undo/redo stack. For large animations you might therefore set it to `False`.\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > A2plus Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 9939, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/About.md", "text": "# About\n1. REDIRECT [Std_About](Std_About.md)\n\n\n---\n⏵ [documentation index](../README.md) > About\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 33, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/About_FreeCAD.md", "text": "# <img alt=\"\" src=images/Freecad_default.jpg style=\"width:1024px;\"> About FreeCAD\n\n**FreeCAD** is a general purpose [open source](http://en.wikipedia.org/wiki/Open_source) parametric 3D [**CAD**](http://en.wikipedia.org/wiki/CAD) modeler licensed under the [LGPL License](License.md). FreeCAD is aimed directly at [mechanical engineering](http://en.wikipedia.org/wiki/Mechanical_engineering) and [product design](http://en.wikipedia.org/wiki/Product_design) but, being very generic, also fits in a wider range of uses around engineering, such as architecture, finite element analysis, 3D printing, and other tasks.\n\nFreeCAD features tools similar to [CATIA](https://en.wikipedia.org/wiki/CATIA), [SolidWorks](http://en.wikipedia.org/wiki/Solidworks), [Solid Edge](http://en.wikipedia.org/wiki/Solid_Edge) or [Revit](https://en.wikipedia.org/wiki/Autodesk_Revit), and therefore also falls into the category of [**CAD**](http://en.wikipedia.org/wiki/CAD), [**PLM**](http://en.wikipedia.org/wiki/Product_Lifecycle_Management), [**CAx**](http://en.wikipedia.org/wiki/CAx), [**CAE**](http://en.wikipedia.org/wiki/Computer-aided_engineering) and [**BIM**](https://en.wikipedia.org/wiki/Building_information_modeling). It is a [feature based parametric modeler](http://en.wikipedia.org/wiki/Parametric_feature_based_modeler) with a modular software architecture making it possible to provide additional functionality without modifying the core system.\n\nAs with other CAD modelers it has many 2D components in order to sketch planar shapes or create production drawings. However, direct 2D drawing (like [Inkscape](https://inkscape.org/) or [AutoCAD LT](http://en.wikipedia.org/wiki/AutoCAD#AutoCAD_LT)) is not the focus, neither are animation or mesh editing (like [Blender](https://www.blender.org/), [Maya](http://en.wikipedia.org/wiki/Maya_(software)), [3ds Max](http://en.wikipedia.org/wiki/3ds_Max), or [Cinema 4D](http://en.wikipedia.org/wiki/CINEMA_4D)). Nevertheless, thanks to its wide adaptability, FreeCAD is useful in a much broader area around its base feature set.\n\nFreeCAD makes heavy use of open-source libraries that exist in the field of [scientific computing](http://en.wikipedia.org/wiki/Scientific_Computation). Among them are [Open Cascade Technology (OCCT)](http://OpenCascade.org), a powerful CAD kernel; [Coin3D](https://github.com/coin3d/coin/wiki), a toolkit for 3D graphics development compatible with [Open Inventor](http://en.wikipedia.org/wiki/Open_Inventor); [Qt](http://www.qt.io/), the world-famous user interface framework; and [Python](http://www.python.org), a modern scripting language. FreeCAD itself can also be used as a library by other programs.\n\nFreeCAD is also [multi-platform](http://en.wikipedia.org/wiki/Cross-platform), and currently runs on Linux/Unix, Windows, and macOS systems with the same look and functionality on all platforms.\n\nFor more information about FreeCAD\\'s capabilities, take a look at the [feature list](Feature_list.md), the [latest release notes](Feature_list#Release_notes.md), and the [getting started](Getting_started.md) articles, or see more [screenshots](Screenshots.md).\n\n### About the FreeCAD project \n\nThe FreeCAD project was started as far back as 2001, as described on the [history](History.md) page.\n\nFreeCAD is maintained and developed by a [community of enthusiastic developers and users](contributors.md) and is built through the patient work of hundreds of contributors, some regular, some occasional. Most work on FreeCAD as volunteers. The [FreeCAD forum](http://forum.freecad.org) is where most of the ideas and decisions are discussed, and the [GitHub repository](https://github.com/FreeCAD/FreeCAD) is where the code is being kept, shared, discussed and worked on. Anybody is [welcome to participate](Help_FreeCAD.md).\n\n### About the FPA \n\nThe FreeCAD project is also supported by a non-profit organization, the [FreeCAD project association (FPA)](https://fpa.freecad.org). The FPA is an independent body created by some FreeCAD veterans in 2021 to collect [donations](donate.md) and other resources to support the project and its community, to help protect that community and allow it to continue developing in the best conditions, and to represent the project against other bodies such as companies and institutions.\n\n\n---\n⏵ [documentation index](../README.md) > [User Documentation](Category_User%20Documentation.md) > About FreeCAD\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1051, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Add_Button_to_FEM_Toolbar_Tutorial.md", "text": "---\n TutorialInfo:\n Topic: FEM\n Level: Advanced\n Time: 60 min\n Author: User:JohnWang\n FCVersion: 0.19\n Files: \n---\n\n# Add Button to FEM Toolbar Tutorial\n\n \n\n\n## Introduction\n\nThe FEM workbench has toolbars and menus. This tutorial shows how to add a test button to a toolbar. It also shows how to add a menu item to a menu.\n\nThe task can be split into four parts:\n\n- **Create a new icon file**.\n- **Register the new icon file**. Modification needed to `src/Mod/Fem/Gui/Resources/Fem.qrc`\n- **Create a new command class**. Modification needed to `src/Mod/Fem/femcommands/commands.py`\n- **Add new command to workbench**. Modification needed to `src/Mod/Fem/Gui/Workbench.cpp`\n\n## Create a new icon file \n\nFor the button, we need an icon file. You can use any of your favorite tools to create it, but it must be in the SVG format. Here we will use the **FEM_testButton.svg** file as an example.\n\nIt must be placed in: `src/Mod/Fem/Gui/Resources/icons/`.\n\n## Register the new icon file \n\nThe new SVG icon file has to be registered for the GUI button by inserting it in `src/Mod/Fem/Gui/Resources/Fem.qrc`:\n\n {{code|code=\n <file>icons/FEM_testButton.svg</file>\n}}\n\n## Create a new command class \n\nA new command class has to be added to the `src/Mod/Fem/femcommands/commands.py` module.\n\nJust copy/paste an existing command, then adjust the icon, menu text and tool-tip in `__init__(self)`:\n\n {{code|code=\nclass _testButton(CommandManager):\n \"The FEM_testButton command definition\"\n\n def __init__(self):\n super(_testButton, self).__init__()\n self.menuetext = \"test Button\"\n self.tooltip = \"This is a test button\"\n self.is_active = \"always\"\n #self.do_activated = \"add_obj_on_gui_selobj_noset_edit\"\n}}\n\nDon\\'t forget to register the command at the bottom of the module file with the `addCommand(...)` method:\n\n {{code|code=\nFreeCADGui.addCommand(\n \"FEM_testButton\",\n _testButton()\n)\n}}\n\n**Note**: Please see this [discussion thread](https://forum.freecadweb.org/viewtopic.php?f=18&t=46693&start=10#p402004) in the forum if icons are involved.\n\n## Add new command to workbench \n\nWe will add the new command to both the **solve** toolbar and the **solve** menu.\n\nSearch for the following code snippet in `/Gui/Workbench.cpp` and add the new command:\n\n {{code|code= \n Gui::ToolBarItem* solve = new Gui::ToolBarItem(root);\n solve->setCommand(\"Solve\");\n *solve << \"FEM_SolverCalculixCxxtools\"\n << \"FEM_SolverCalculiX\"\n << \"FEM_SolverElmer\"\n+ << \"FEM_testButton\"\n << \"Separator\"\n}}\n\nTo add the command to the **solve** menu of the FEM workbench, search for the following code snippet in `Workbench.cpp`:\n\n {{code|code= \n Gui::MenuItem* solve = new Gui::MenuItem;\n root->insertItem(item, solve);\n solve->setCommand(\"&Solve\");\n *solve << \"FEM_SolverCalculixCxxtools\"\n << \"FEM_SolverCalculiX\"\n << \"FEM_SolverElmer\"\n << \"FEM_SolverZ88\"\n+ << \"FEM_testButton\"\n << \"Separator\"\n}}\n\n**Result**: You should have just successfully added a test button to a FEM workbench toolbar and menu. Now, you can [compile FreeCAD](Compiling.md) and test your new button.\n\n## Related\n\n- [Extend FEM Module](Extend_FEM_Module.md)\n- [Onboarding FEM Devs](Onboarding_FEM_Devs.md)\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Add Button to FEM Toolbar Tutorial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 942, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Add_FEM_Constraint_Tutorial.md", "text": "---\n TutorialInfo:\n Topic: Add FEM Constraint\n Level: \n Time: \n Author: User:M42kus\n FCVersion: \n Files: \n---\n\n# Add FEM Constraint Tutorial\n\n \n\n\n## Introduction\n\nIn this tutorial, we are going to add the flow velocity constraint to FreeCAD and implement support for the Elmer solver. Please make sure you have read and understood [Extend FEM Module](Extend_FEM_Module.md) before reading this tutorial.\n\nThis tutorial only covers how to implement constraints in Python. In contrast to solver and equations, constraints follow the classic FEM module structure. That is, all modules of a constraint have their place in either the {{Incode|femobjects}} or {{Incode|femviewprovider}} package.\n\n## Summary\n\n1. **Create document object:** The document object that resides inside the analysis and through which the constraint can be parametrized and attached to boundaries.\n2. **Create GUI command:** Add a command to the FEM workbench that adds a flow constraint to the active analysis.\n3. **Create a task panel:** The task panel is necessary to allow the user to set the boundaries at which he wants to set the velocity constraint. It also makes entering the parameters a little more user-friendly.\n4. **Extend Elmer\\'s writer:** Add support for the new constraint to Elmer by extending its sif file exporter.\n\n## Create document object \n\nIn this step we are going to modify the following files: \n\n- **src/Mod/Fem/CMakeLists.txt**\n \n\n- **src/Mod/Fem/App/CMakeLists.txt**\n \n\n- **src/Mod/Fem/ObjectsFem.py**\n \n\n\nAnd add the following files: \n\n- **src/Mod/Fem/femobjects/constraint_flowvelocity.py**\n \n\n- **src/Mod/Fem/femviewprovider/view_constraint_flowvelocity.py**\n \n\n\nA document proxy and a view proxy are required for the new constraint. Those reside in separate modules. The document proxy in femobjects and the view proxy in femviewprovider. Just copy the modules from an existing constraint e.g.: \n\n- **femobjects/constraint_selfweight.py**\n \n\n- **femviewprovider/view_constraint_selfweight.py**\n \n\n\nAdjust the Type variable and the properties to your needs. The document proxy of the flow constraint looks like the following:\n\n \n```python\nclass Proxy(FemConstraint.Proxy):\n Type = \"Fem::ConstraintFlowVelocity\"\n def __init__(self, obj):\n super(Proxy, self).__init__(obj)\n obj.addProperty(\n \"App::PropertyFloat\", \"VelocityX\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyBool\", \"VelocityXEnabled\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyFloat\", \"VelocityY\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyBool\", \"VelocityYEnabled\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyFloat\", \"VelocityZ\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyBool\", \"VelocityZEnabled\",\n \"Parameter\", \"Body heat flux\")\n obj.addProperty(\n \"App::PropertyBool\", \"NormalToBoundary\",\n \"Parameter\", \"Body heat flux\")\n```\n\nThe module containing the view proxy might look a little more complicated. But for now just adjust the icon path. We are going to come back to this file in later steps of the tutorial.\n\n \n```python\nclass ViewProxy(FemConstraint.ViewProxy):\n def getIcon(self):\n return \":/icons/fem-constraint-flow-velocity.svg\"\n```\n\nAdd the two new modules to the build system as described in [Extend FEM Module](https://www.freecadweb.org/wiki/Extend_FEM_Module). Locate the correct list by searching for constraint modules.\n\nAs all objects of the FEM workbench, the velocity constraint must be registered in {{Incode|ObjectsFem.py}}. The following method adds a velocity constraint to the active document. This method will be used by the GUI command to add the constraint. It must be inserted somewhere in {{Incode|ObjectsFem.py}}.\n\n \n```python\ndef makeConstraintFlowVelocity(name=\"FlowVelocity\"):\n obj = FreeCAD.ActiveDocument.addObject(\"Fem::ConstraintPython\", name)\n import femobjects.constraint_flowvelocity\n femobjects.constraint_flowvelocity.Proxy(obj)\n if FreeCAD.GuiUp:\n import femviewprovider.view_constraint_flowvelocity\n femviewprovider.view_constraint_flowvelocity.ViewProxy(obj.ViewObject)\n return obj\n```\n\n## Create GUI command \n\nIn this step we are going to modify the following files: \n\n- **src/Mod/Fem/CMakeLists.txt**\n \n\n- **src/Mod/Fem/App/CMakeLists.txt**\n \n\n- **src/Mod/Fem/Gui/Workbench.cpp**\n \n\n\nAnd add the following new file: \n\n- **src/Mod/Fem/femobjects/constraint_flowvelocity.py**\n \n\n\nThe command allows the user to actually add the constraint to the active analysis. Just copy a command from an existing constraint. Commands reside in the {{Incode|femviewprovider}} package. Adjust the resources attribute and the make method called in Activated to your needs. Also use a different command id in the addCommand call on the bottom of the module. The following class is the command class of the velocity constraint.\n\n \n```python\nclass Command(FemCommands.FemCommands):\n\n def __init__(self):\n super(Command, self).__init__()\n self.resources = {\n 'Pixmap': 'fem-constraint-flow-velocity',\n 'MenuText': QtCore.QT_TRANSLATE_NOOP(\n \"FEM_ConstraintFlowVelocity\",\n \"Constraint Velocity\"),\n 'ToolTip': QtCore.QT_TRANSLATE_NOOP(\n \"FEM_ConstraintFlowVelocity\",\n \"Creates a FEM constraint body heat flux\")}\n self.is_active = 'with_analysis'\n\n def Activated(self):\n App.ActiveDocument.openTransaction(\n \"Create FemConstraintFlowVelocity\")\n Gui.addModule(\"ObjectsFem\")\n Gui.doCommand(\n \"FemGui.getActiveAnalysis().Member += \"\n \"[ObjectsFem.makeConstraintFlowVelocity()]\")\n\nGui.addCommand('FEM_AddConstraintFlowVelocity', Command())\n```\n\nAdd the new command file to the build system as decripted in [Extend FEM Module](https://www.freecadweb.org/wiki/Extend_FEM_Module). Locate the correct list be searching for existing command modules.\n\nPut the command into Gui/Workbench.cpp to add it to the toolbar and menu. Search for an existing constraint of the same category as the new one (e.g. Flow) copy-paste it and adjust the command id. This should be done two times. Once for the menu and again for the toolbar.\n\n## Create a task panel \n\nIn this step, we are going to modify the following file: \n\n- **src/Mod/Fem/femviewprovider/view_constraint_flowvelocity.py**\n \n\n\nIn FreeCAD, constraint objects benefit greatly from task panels. Task panels can make use of more powerful input widgets that expose the unit of entered values directly to the user. The velocity constraint even requires the use of a task panel since a task panel is the only way of specifying the face(s) on which the constraint shall be applied.\n\nThe location of the module in which task panels are implemented is not strictly defined. For the velocity constraint, we are just going to put the task panel in the same module where we put the view proxy. The task panel is quite complicated. It makes use of the FemSolectionWidgets.BoundarySelector(). That\\'s a qt widget that allows the user to select the boundaries on which the constraint shall be applied. In addition to this widget, it generates another one by loading a UI file specifically created for the velocity constraint. Via this widget, the velocity vector can be specified.\n\nMost of the time it should be sufficient to just copy this class, use a suitable UI file (instead of TaskPanelFemFlowVelocity.ui) and adjust \\_initParamWidget() as well as \\_applyWidgetChanges(). If the new constraint requires bodies as references instead of boundaries just replace the BoundarySelector object with the SolidSelector.\n\n \n```python\nclass _TaskPanel(object):\n\n def __init__(self, obj):\n self._obj = obj\n self._refWidget = FemSelectionWidgets.BoundarySelector()\n # self._refWidget = FemSelectionWidgets.SolidSelector()\n self._refWidget.setReferences(obj.References)\n self._paramWidget = Gui.PySideUic.loadUi(\n App.getHomePath() + \"Mod/Fem/femviewprovider/TaskPanelFemFlowVelocity.ui\")\n self._initParamWidget()\n self.form = [self._refWidget, self._paramWidget]\n analysis = FemMisc.findAnalysisOfMember(obj)\n self._mesh = FemMisc.getSingleMember(analysis, \"Fem::FemMeshObject\")\n self._part = self._mesh.Part if self._mesh is not None else None\n self._partVisible = None\n self._meshVisible = None\n\n def open(self):\n if self._mesh is not None and self._part is not None:\n self._meshVisible = self._mesh.ViewObject.isVisible()\n self._partVisible = self._part.ViewObject.isVisible()\n self._mesh.ViewObject.hide()\n self._part.ViewObject.show()\n\n def reject(self):\n self._restoreVisibility()\n return True\n\n def accept(self):\n if self._obj.References != self._refWidget.references():\n self._obj.References = self._refWidget.references()\n self._applyWidgetChanges()\n self._obj.Document.recompute()\n self._restoreVisibility()\n return True\n\n def _restoreVisibility(self):\n if self._mesh is not None and self._part is not None:\n if self._meshVisible:\n self._mesh.ViewObject.show()\n else:\n self._mesh.ViewObject.hide()\n if self._partVisible:\n self._part.ViewObject.show()\n else:\n self._part.ViewObject.hide()\n\n def _initParamWidget(self):\n unit = \"m/s\"\n self._paramWidget.velocityXTxt.setText(\n str(self._obj.VelocityX) + unit)\n self._paramWidget.velocityYTxt.setText(\n str(self._obj.VelocityY) + unit)\n self._paramWidget.velocityZTxt.setText(\n str(self._obj.VelocityZ) + unit)\n self._paramWidget.velocityXBox.setChecked(\n not self._obj.VelocityXEnabled)\n self._paramWidget.velocityYBox.setChecked(\n not self._obj.VelocityYEnabled)\n self._paramWidget.velocityZBox.setChecked(\n not self._obj.VelocityZEnabled)\n self._paramWidget.normalBox.setChecked(\n self._obj.NormalToBoundary)\n\n def _applyWidgetChanges(self):\n unit = \"m/s\"\n self._obj.VelocityXEnabled = \\\n not self._paramWidget.velocityXBox.isChecked()\n if self._obj.VelocityXEnabled:\n quantity = Units.Quantity(self._paramWidget.velocityXTxt.text())\n self._obj.VelocityX = float(quantity.getValueAs(unit))\n self._obj.VelocityYEnabled = \\\n not self._paramWidget.velocityYBox.isChecked()\n if self._obj.VelocityYEnabled:\n quantity = Units.Quantity(self._paramWidget.velocityYTxt.text())\n self._obj.VelocityY = float(quantity.getValueAs(unit))\n self._obj.VelocityZEnabled = \\\n not self._paramWidget.velocityZBox.isChecked()\n if self._obj.VelocityZEnabled:\n quantity = Units.Quantity(self._paramWidget.velocityZTxt.text())\n self._obj.VelocityZ = float(quantity.getValueAs(unit))\n self._obj.NormalToBoundary = self._paramWidget.normalBox.isChecked()\n```\n\nThe view proxy must be extended to support the task panel we just implemented. The following extended view proxy opens the task panel when the user makes a double-click on the constraint object in the tree view.\n\n \n```python\nclass ViewProxy(FemConstraint.ViewProxy):\n\n def getIcon(self):\n return \":/icons/fem-constraint-flow-velocity.svg\"\n\n def setEdit(self, vobj, mode=0):\n task = _TaskPanel(vobj.Object)\n Gui.Control.showDialog(task)\n\n def unsetEdit(self, vobj, mode=0):\n Gui.Control.closeDialog()\n\n def doubleClicked(self, vobj):\n if Gui.Control.activeDialog():\n Gui.Control.closeDialog()\n Gui.ActiveDocument.setEdit(vobj.Object.Name)\n return True\n```\n\n## Extend Elmer\\'s writer \n\nIn this step we are going to modify the following file: \n\n- **src/Mod/Fem/femsolver/elmer/writer.py**\n \n\n\nThe writer module contains methods for all equation types. Depending on the type of the constraint, boundary condition, initial condition or body force one has to modify different methods. For our flow velocity we have to adjust {{Incode|_handleFlowBndConditions(...)}}.\n\n \n```python\ndef _handleFlowBndConditions(self):\n for obj in self._getMember(\"Fem::ConstraintFlowVelocity\"):\n if obj.References:\n for name in obj.References[0][1]:\n if obj.VelocityXEnabled:\n velocity = getFromUi(obj.VelocityX, \"m/s\", \"L/T\")\n self._boundary(name, \"Velocity 1\", velocity)\n if obj.VelocityYEnabled:\n velocity = getFromUi(obj.VelocityY, \"m/s\", \"L/T\")\n self._boundary(name, \"Velocity 2\", velocity)\n if obj.VelocityZEnabled:\n velocity = getFromUi(obj.VelocityZ, \"m/s\", \"L/T\")\n self._boundary(name, \"Velocity 3\", velocity)\n if obj.NormalToBoundary:\n self._boundary(name, \"Normal-Tangential Velocity\", True)\n self._handled(obj)\n```\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > Add FEM Constraint Tutorial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2995, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Add_FEM_Equation_Tutorial.md", "text": "---\n TutorialInfo:\n Topic: Add FEM Equation\n Level: Advanced\n Time: 1 day\n Author: User:JohnWang\n FCVersion: 0.19\n---\n\n# Add FEM Equation Tutorial\n\n \n\n\n## Introduction\n\nIn this tutorial, we are going to add the **Flow** equation to FreeCAD and implement support for the Elmer solver. Please make sure you have read and understood [Extend FEM Module](Extend_FEM_Module.md) before reading this tutorial.\n\nThe task can be split into five parts:\n\n- **New equation type**. This step must only be done if the equation doesn\\'t exist in FreeCAD yet (as opposed to an equation that is already in FreeCAD but not supported by the target solver).\n- **New equation object**. Adding a concrete document object representing the Elmer-specific equation.\n- **Extend solver object**. Adding support for the new equation to the solver object of Elmer.\n- **Extend writer object**. Extending the analysis export of Elmer to support the new equation type.\n- **Gui tool to create an equation**. Access the new equation function through workbench Gui.\n\n## New equation type \n\nIn this step we are going to modify the following file:\n- **src/Mod/Fem/femsolver/equationbase.py**\n \n\n\nThe equation type is shared among all equation objects of the different solvers. Each type has a string specifier (e.g. \\\"Heat\\\") and a dedicated command that adds the equation to the selected solver. This allows for a simpler GUI where we have only one button for the heat equation which is used for all supported solver.\n\nFirst, add the new equation to the {{Incode|equationbase.py}} module. Each equation requires two classes. A document proxy and a view proxy. Those two classes will later be used as base classes for the Elmer-specific equation classes. Just copy-paste them from an existing equation type and adjust the icon path inside {{Incode|getIcon(self)}} of the view proxy.\n\n \n```python\nclass FlowProxy(BaseProxy):\n pass\n\nclass FlowViewProxy(BaseViewProxy):\n def getIcon(self):\n return \":/icons/FEM_EquationFlow.svg\"\n```\n\n## New Elmer\\'s equation object \n\nIn this step, we are going to implement the document object. We need to add a new {{Incode|flow.py}} file at:\n- **src/Mod/Fem/femsolver/elmer/equations/flow.py**\n \n\n\nand modify the following files:\n- **src/Mod/Fem/ObjectsFem.py**\n \n\n- **src/Mod/Fem/CMakeLists.txt**\n \n\n\nLet\\'s start with adding the new {{Incode|flow.py}} file. This file can be copied from an existing equation.\n\n### Keywords\n\n- If the new equation only supports keywords for **linear** systems copy the {{Incode|femsolver/elmer/equations/elasticity.py}} module.\n- If the new equation supports keywords for both **linear** and **non-linear** systems, copy {{Incode|femsolver/elmer/equations/heat.py}}.\n\nThe flow equation in Elmer is a potentially non-linear equation. This means that we are going to base our work on {{Incode|heat.py}}.\n\n### Editing files \n\nAfter copying {{Incode|heat.py}} to {{Incode|flow.py}}, adjust {{Incode|flow.py}} in these locations:\n\n- the name argument of the {{Incode|create}} module function,\n- the base classes of the {{Incode|Proxy}} class,\n- the {{Incode|Type}} attribute of the {{Incode|Proxy}} class,\n- the {{Incode|ViewProxy}} classes.\n\n \n```python\ndef create(doc, name=\"'''Flow'''\"):\n return femutils.createObject(\n doc, name, Proxy, ViewProxy)\n\nclass Proxy(nonlinear.Proxy, equationbase.'''Flow'''Proxy):\n\n Type = \"Fem::EquationElmer'''Flow'''\"\n\n def __init__(self, obj):\n super(Proxy, self).__init__(obj)\n obj.Priority = 10\n\nclass ViewProxy(nonlinear.ViewProxy, equationbase.'''Flow'''ViewProxy):\n pass\n```\n\nThen you need to change the properties added via the {{Incode|obj.addProperty(..)}} function to those needed by the equation.\n\nAt the moment of writing this tutorial Elmer flow equation doesn\\'t have any special properties. See the Elmer elasticity equation for an example with properties.\n\nFinally one has to register a **makeEquationFlow** definition in {{Incode|src/Mod/Fem/ObjectsFem.py}} by duplicating an available entry.\n\nFreeCAD uses **make** to build the program. So we need to register the new module file ({{Incode|flow.py}}) in {{Incode|src/Mod/Fem/CMakeLists.txt}} the way described in [Extend FEM Module](https://www.freecadweb.org/wiki/Extend_FEM_Module). The suitable lists can be easily found by searching for existing equation module files of Elmer.\n\n## Extend Solver Object \n\nIn this step we are going to modify the following file:\n- **src/Mod/Fem/femsolver/elmer/solver.py**\n \n\n\nRight now we made FreeCAD aware that there is a new type of equation and even added a command that adds this equation to the selected solver object. We also implemented a concrete equation object for Elmer. What\\'s left to do now is to make the connection between Elmer and the flow equation. This must be done directly in the Elmer solver object.\n\nRegister the module in which we just implemented our new equation object ({{Incode|flow.py}}) with the equation specifier from step 1 (\\\"Flow\\\") in the {{Incode|_EQUATIONS}} list in {{Incode|elmer/solver.py}}.\n\n \n```python\nfrom .equations import electrostatic\n+from .equations import flow\n\n...\n\n_EQUATIONS = {\n \"Heat\": heat,\n \"Elasticity\": elasticity,\n+ \"Flow\": flow,\n}\n```\n\n## Extend writer object \n\nIn this step we are going to modify the following file:\n- **src/Mod/Fem/femsolver/elmer/writer.py**\n \n\n\nThis file contains the {{Incode|Writer}} class which exports the analysis into Elmer SIF format.\n\nFor every supported equation, there are two main methods handling the export of the respective equation. Just copy all of them from an existing equation and adjust them to your needs.\n- {{Incode|_getFlowSolver}}\n \n\n- {{Incode|_handleFlow}}\n \n\n\nYou need to register the {{Incode|_handleFlow}} method inside the {{Incode|Writer}} class:\n\n \n```python\nclass Writer(object):\n...\n def write(self):\n...\n self._handleFlow()\n\n...\n\n```\n\n\n{{Incode|_handleFlow}}\n\ncan control a series of other detailed methods. Our flow equation uses the following detailed methods:\n- {{Incode|_handleFlowConstants}}\n \n\n- {{Incode|_handleFlowMaterial}}\n \n\n- {{Incode|_handleFlowInitialVelocity}}\n \n\n- {{Incode|_handleFlowBndConditions}}\n \n\n- {{Incode|_handleFlowEquation}}\n \n\n\nWe now finished the function part of the new equation. Next, we\\'ll connect the new equation through the GUI.\n\n## Gui tool to create an equation \n\nWe have just created a new equation class. To access it from the FEM GUI, we need to create a button and link it to the new equation class. Here is a tutorial: [Add Button to FEM Toolbar Tutorial](Add_Button_to_FEM_Toolbar_Tutorial.md).\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > [Developer Documentation](Category_Developer%20Documentation.md) > Add FEM Equation Tutorial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1679, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Addon.md", "text": "# Addon\n## Introduction\n\nIn FreeCAD and in this documentation, an [addon](addon.md) is any component that is not part of the base installation, but that can be added to the system by certain methods.\n\n## Different types \n\nThere are three types of addons:\n\n- [Macros](Macros.md): short snippet of [Python](Python.md) code that provides a new tool or functionality in a single file ending with `.FCMacro`.\n- [Workbenches](External_workbenches.md): collections of Python files that provide related [Gui Commands](Gui_Command.md) (tools) centered around a particular topic, for example, tools to design cabinets, or tools to work with architecture, or tools to design boats, etc. These workbenches usually define new toolbars where [commands](Gui_Command.md) are placed as buttons.\n- [Preference Packs](Preference_Packs.md): distributable collections of user preferences. <small>(v0.20)</small> \n\n## Installation\n\nThe recommended way to install addons is with the <img alt=\"\" src=images/Std_AddonMgr.svg style=\"width:24px;\"> [Addon Manager](Std_AddonMgr.md).\n\nBut for macros and workbenches manual installation is also possible:\n\n- [How to install macros](How_to_install_macros.md)\n- [Installing more workbenches](Installing_more_workbenches.md)\n\n## Information for developers \n\nIf you have developed a macro or workbench, and want to see it included in the Addon manager, read how to do so on the repository pages: ([FreeCAD-addons](https://github.com/FreeCAD/FreeCAD-addons/) and [FreeCAD-macros](https://github.com/FreeCAD/FreeCAD-macros/)). If you add your macro to the [Macros recipes](Macros_recipes.md) page, there is nothing else to do, it will automatically be picked up by the Addon manager.\n\nSee also:\n\n- [Distribution of a Python workbench](Workbench_creation#Distribution.md)\n- [Distribution of a C++ workbench](Workbench_creation#Distribution_2.md)\n\n\n---\n⏵ [documentation index](../README.md) > [Addons](Category_Addons.md) > Addon\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 473, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/AddonManager.md", "text": "# AddonManager\n1. REDIRECT [Std AddonMgr](Std_AddonMgr.md)\n\n\n---\n⏵ [documentation index](../README.md) > AddonManager\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 39, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Advanced_Attachment_OYX.md", "text": "---\n TutorialInfo:\n Topic: Attachment\n Level: Intermediate/Advanced\n Author: drmacro\n Time: 1 hour\n FCVersion: 0.19 or above\n Files: TBD\n---\n\n# Advanced Attachment OYX\n\n \n\n\n <img alt=\"\" src=images/AttOYX_Setup.png style=\"width:800px;\"> \n*The objects in initial position*\n\n## Introduction\n\nThis demonstration addresses the use of the OYX attachment mode to adjust the position of the origin of a sketch as described in [Part:Attachment](Part_EditAttachment.md), it is not comprehensive, but hopefully will help users experiment.\n\nThe image above shows the geometry used in this demonstration.\n\nThe lower right frame shows the top view of the scene. Note the scene includes a sketch containing a square and text indicating the vertical (Y), horizontal (X) axes of the sketch. The lower left corner of the square is located at 0,0,0 of the sketch (the origin of the sketch).\n\nThe origin of the sketch and the global origin (designated by the red, green and blue [axis cross](Std_AxisCross.md)) are the same. In the other frames of the image we can see that the square is at Z=0, so the sketch is in the XY plane.\n\nThere are two other sketches which include geometry that will be used to re-position the sketch containing the square. One sketch contains an orange line that is oriented along the global Z axis in the XZ plane. The other sketch contains a yellow line in the XY plane.\n\n## Discussion\n\nAttachment mode Align O-Y-X is defined as follows in [Part:Attachment](Part_EditAttachment.md): *Matches object\\'s origin with first referenced vertex and aligns its vertical and horizontal plane axes toward vertex/along line.*. It also notes there are several reference combinations.\n\n:; Reference combinations:\n\n: Vertex, Vertex, Vertex\n: Vertex, Vertex, Edge\n: Vertex, Edge, Vertex\n: Vertex, Edge, Edge\n: Vertex, Vertex\n: Vertex, Edge\n\nLets start with *Vertex, Vertex, Vertex*.\n\nIf we match the definition to the reference:\n\nThe first vertex selected will position the origin of the sketch to the selected vertex.\n\nThe second vertex selected will align the vertical axis of the sketch (in the demo setup this axis is indicated with **Y**).\n\nSo, if we select the upper left/upper vertex of the yellow edge (as seen in the larger right frame) and the lower/right vertex of the yellow edge the sketch is positioned like this:\n\n <img alt=\"\" src=images/AttOYX_vv.png style=\"width:800px;\"> \n\n:; Notes:\n\n: The Align O-Y-X is selected in the Attachment dialogue.\n: The sketch origin is now at the upper left/upper vertex of the yellow line.\n: The Y axis of the sketch is now aligned with the yellow line.\n: The Z axis of the sketch is perpendicular to the yellow line.\n\nNow if we add a third reference by selecting the upper vertex of the orange edge the scene changes to:\n\n <img alt=\"\" src=images/AttOYX_vvv.png style=\"width:800px;\"> \n\n:; Notes:\n\n: Now the X axis of the sketch is aligned in the direction of the selected vertex of the orange edge.\n\n\n---\n⏵ [documentation index](../README.md) > Advanced Attachment OYX\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 717, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Advanced_TechDraw_Tutorial.md", "text": "---\n TutorialInfo:\n Topic: Modeling\n Level: Experienced User\n Author: domad\n FCVersion: 0.19.23300 or higher\n---\n\n# Advanced TechDraw Tutorial\n\n\n \n\n\n## Purpose in Brief \n\nCreate points, lines, circles, arcs, etc. in TechDraw views and/ or entire \\\"cosmetic\\\" drawings with absolute precision, suitable for the dimensioning tools that the workbench is equipped with, to generate compliant and detailed technical drawings.\n\n## Introduction\n\nThis tutorial introduces the experienced user to some advanced use of existing tools and techniques from other workbenches to extend actually missing functionality in <img alt=\"\" src=images/Workbench_TechDraw.svg style=\"width:24px;\"> [TechDraw Workbench](TechDraw_Workbench.md). This tutorial is not a complete and comprehensive guide to the TechDraw Workbench and many of the tools and capabilities are not covered. It should contribute to overcome the difficulties that are encountered in quoting and enriching the technical drawing using TechDraw. This tutorial will take advanced users through the steps needed to produce challenging technical drawings of the part from the [Basic Part Design Tutorial](Basic_Part_Design_Tutorial.md) using drawing tools of the\n\n1. <img alt=\"\" src=images/Workbench_Draft.svg style=\"width:24px;\"> [Draft Workbench](Draft_Workbench.md) (lines, polylines, circumferences, arcs, splines, beziers, etc.), in particular the snaps, to create on the object effectively precise \\\"cosmetic points\\\" that could then be used for dimensioning in TechDraw.\n2. It is also possible to use the <img alt=\"\" src=images/Workbench_Sketcher.svg style=\"width:24px;\"> [Sketcher Workbench](Sketcher_Workbench.md) as\n - generator of \\\"base-sketchTD\\\" (sketch bases for TechDraw) in 2D (e.g. such as system diagram, floor plans, elevations, views of mechanical or overall parts, etc.) or by\n - using directly the sketches that generated the 3D models, or by\n - converting to sketch the \"facebinder\" generated with Draft obtained from faces and/ or sections of the 3D models.\n3. To obtain particular sections (cuts on different planes or axes) to be presented on the page in TechDraw (it is advised to use a copy of the original 3D object), then through the creation of planes (even on different axes) using the <img alt=\"\" src=images/Workfeature_workbench_icon.svg style=\"width:24px;\"> [Workfeature Workbench](Workfeature_Workbench.md), it is possible to section the copy of the 3D object <img alt=\"\" src=images/Part_SliceApart.svg style=\"width:24px;\"> [Part SliceApart](Part_SliceApart.md) to obtain the faces to be converted into sketch <img alt=\"\" src=images/Draft_Draft2Sketch.svg style=\"width:24px;\"> [Draft Draft2Sketch](Draft_Draft2Sketch.md) and then through the Sketcher Workbench edit them to make them suitable to the technical drawing that we are interested in generating in TechDraw. The [Workfeature Workbench](Workfeature_Workbench.md) (and [Macro WorkFeatures](Macro_WorkFeatures.md)) are full of convenient additional functions, that allow us to easily create planes (theoretically infinite in extension and quantity) by selecting three points (vertices) *(remember that for three points passing, one and only one plane passes through three non-aligned points one and only one plane passes through three non-aligned points*) is a geometric axiom, which confirms without any ambiguity (!) the validity and importance of the WorkFeatureDev tool to create precise plans very easily.\n\n(\\**This is quite comparable to AutoCAD Slice command [1](https://knowledge.autodesk.com/support/autocad/learn-explore/caas/CloudHelp/cloudhelp/2019/ENU/AutoCAD-Core/files/GUID-27593C5E-4B89-41F2-872B-927D69517CBF-htm.html) which is based on that axiom. Without pre-building any new plane, a cutting plane using three points is defined.*)\n\n*Note: These planes can be joined together by overlapping/ coinciding of two edges using the Boolean feature of <img alt=\"\" src=images/Part_Fuse.svg style=\"width:24px;\"> [Part Union](Part_Fuse.md).* The planes thus formed and suitably positioned (according to our provisions) will be used as **cutting blades** <img alt=\"\" src=images/Part_SliceApart.svg style=\"width:24px;\"> [Part SliceApart](Part_SliceApart.md), cutting our 3D object into several parts according to the chosen planar confirmation.\\'\\'\n\n## Before You Begin \n\nThe Workbenches that are used to produce the drawings of the attached examples are:\n\\* <img alt=\"\" src=images/Workbench_Part.svg style=\"width:24px;\"> [Part Workbench](Part_Workbench.md)\n\n- <img alt=\"\" src=images/Workbench_Draft.svg style=\"width:24px;\"> [Draft Workbench](Draft_Workbench.md)\n- <img alt=\"\" src=images/Workbench_Sketcher.svg style=\"width:24px;\"> [Sketcher Workbench](Sketcher_Workbench.md)\n- <img alt=\"\" src=images/Workfeature_workbench_icon.svg style=\"width:24px;\"> [Workfeature Workbench](Workfeature_Workbench.md)\n- <img alt=\"\" src=images/Workbench_TechDraw.svg style=\"width:24px;\"> [TechDraw Workbench](TechDraw_Workbench.md)\n\n## The Task \n\nStages of the procedure:\n\n1. Creation of the 3D object(s) according to the canons of traditional modeling;\n2. Possible creation of independent or simple copies, eg. to be used for the creation of specific continuous sections positioned on multiple planes or axes, and which then through the use of the \\\"facebinder\\\", \\\"Draft to Sketch\\\", Shape 2D View, etc. functions. it will allow us to produce perfect \"Sketches\", then edit them to make them (by creating ad hoc \"cosmetic points or lines\") usable in TechDraw; to these sketches I gave the name of \\\"base-sketchTD\\\";\n3. insertion / creation of \\\"base-sketchTD\\\" in the layers of belonging (also with \\\"drag and drop\\\");\n4. creation of the drawing page with its template;\n5. creation of the view with TechDraw: select the layer or the grouping folder (which contains the \"base-sketchTD\") from the structure, then click on the \"insert view\" button; TechDraw will insert the contents of the layer or grouping folder into the view. For a correct creation \\\"base-sketchTD\\\" must be perpendicular to the monitor / display view; I point out that whatever we add later in the layer or in the grouping-folder, or modifications of the \"base-sketchTD\", will be updated in realtime in the TechDraw view. Keep in mind that updates and / or modifications may affect the dimensions already introduced or cosmetic lines created with the specific tool of TechDraw in the view.\n6. once the \"base-sketchTD\" has been defined in the view, we can move on to dimensioning with the appropriate TechDraw tools;\n\nIt is possible to insert the \\\"base-sketchTD\\\" also in the projection group views:\n\n- select the projection view -\\> properties tab -\\> Data -\\> \"Projection\" record section -\\> Source click on the button with the three dots and directly add the \"base-sketchTD\" or the layer that contains it.\n\n: It should be noted that the \\\"base-sketchTD\\\" must be positioned on the highest face of the model / object, otherwise it will be hidden and will be invisible in TechDraw.\n\nThe sections obtained from the views do not seem to have this possibility. Whenever it is necessary to create precise cosmetic points suitable for dimensioning (e.g. tangency points), they can be generated:\n\n- in \\\"Sketcher\\\" through construction lines and inserting circles with infinitesimal diameter / radius (0.00001) in the ends, these will be seen by TechDraw as points / vertices suitable for dimensioning;\n- in Draft with the same method to be inserted in the relevant layer or folder-grouping;\n\n: once the \\\"base-sketchTD\\\" has been modified or the Draft object added in the layer or grouping folder, TechDraw will automatically update the view, if this does not happen, update manually with the appropriate command.\n\nTo insert section fills or patterns:\npay attention to the lines created on the faces that intersect two or more edges, they are seen by TechDraw as separating elements of the face that affect the creation of the fills or patterns. This occurs e.g. when creating the outer lines that define the thread of a hole, this line will prevent the fill or pattern from extending further preventing it from arriving on the one that defines the pre-drill hole. In this case it is better to create cosmetic points through construction lines by inserting circles of infinitesimal radius in the vertices that will be seen by TechDraw as cosmetic points and then join them in TechDraw with create cosmetic line by two points.\nAll lines and / or paths (including cosmetic ones) that are displayed in the views can be edited in the formatting through TechDraw\\'s \"Change Apparence of selected Lines\" command.\nTo create specific continuous sections on different axes or planes, I used the \"WorkFeatureDev\" workbench which allows you to create \"solid\" planes, with a thickness of \"0\", by selecting three vertices. These planes can be joined through a common or overlapping edge using the Boolean functions of the \"Part\" workbench and subsequently used for slicing / sectioning the solid model through the \"Slice apart\" command of the same workbench. The faces of the cut objects can be suitably exploited for the creation, with the \"Facebinder\" function, the \"base-sketchTD\"s to produce specific section views in TechDraw and therefore to be able to dimension and detail them.\nI believe I have made public every \\\"trick\\\" (or rather system) experimented to be able to use more specific tools (not provided for TechDraw) and create high quality professional technical drawings without any limits, making the TechDraw workbench more efficient and adaptable to any need , in all likelihood on par (if not more flexible and powerful) than commercial peers.\nIt should be said, which is not negligible, that with this system it is possible to create entire 2D files and quote them with TechDraw in the same way as \\\"LibreCad\\\" or \\\"Autocad LT\\\" or other two-dimensional cads.\nI hope I was clear enough (translation permitting) in explaining the procedure (\\\"trick / system\\\") that I believe to be \\\"easier to do than to say\\\", as it is all about being able to enter 2D drawings into the views of TDs created with \\\"Draft\\\" and / or with \\\"Sketcher\\\" simply by selecting them from the structure and creating a view in TD with the appropriate command \\\"create a view\\\"; but I thought of doing something pleasant and more technical by describing the procedure, certainly, in a \\\"simplified\\\" way to create a minimum of organized workflow.\nIt is up to each of us, with imagination and inventiveness, to optimize it to the maximum to obtain the best result.\nI am attaching the files of some workflow examples of technical drawings (not feasible with TechDraw only) from which the images shown below were taken.\nIn the hope of having been useful, good work and good experimentation!\n\n## Notes\n\n## Future Outlook \n\nHowever, the described path could represent the starting point (or the idea) to write additional code to automate the system and integrate it directly into TechDraw with appropriate button / command functions.\n\n## Links\n\n- [Macro WorkFeatures](https://wiki.freecadweb.org/Macro_WorkFeatures) Wiki page to macro\n- [FreeCAD WorkFeature Workbench](https://github.com/Rentlau/WorkFeature-WB) Repository to source code\n- [TechDraw without limits = Layout autocad](https://forum.freecadweb.org/viewtopic.php?t=54499) Forum Thread\n- [TechDraw: -- come utilizzare gli strumenti Draft/Snaps per creare \" vertici/punti cosmetici\"](https://forum.freecadweb.org/viewtopic.php?f=28&t=53329) Forum Thread in Italian language\n\n {{TechDraw Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [TechDraw](Category_TechDraw.md) > Advanced TechDraw Tutorial\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2693, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Aeroplane.md", "text": "---\n TutorialInfo:\n Topic: Part Workbench\n Level: Beginner\n Time: 10 minutes\n Author: Hughthecat\n FCVersion: \n Files: \n---\n\n# Aeroplane\n\n \n\n\n## First Steps \n\nWe will be working in the <img alt=\"\" src=images/Workbench_Part.svg style=\"width:24px;\"> [Part Workbench](Part_Workbench.md) - select it from menus via **View → Workbench → Part** or from the [Workbench Selector](Std_Workbench.md).\n\n- Create a new empty document.\n- Switch to <img alt=\"\" src=images/Std_ViewIsometric.svg style=\"width:24px;\"> [isometric view](Std_ViewIsometric.md).\n- Toggle axis cross **ON** (via View Menu).\n- Ensure you have the [Combo View](Combo_view.md) showing (via **View → Views**).\n\n- Create a cylinder by clicking on the <img alt=\"\" src=images/Part_Cylinder.svg style=\"width:24px;\"> [Cylinder](Part_Cylinder.md) button.\n- Select it by clicking on Cylinder in the Project viewer.\n- Click on the Data tab at the bottom of the Project viewer.\n\nChange the Height to 20mm. Leave the Radius at 2mm.\n\nClick on [Placement](Placement.md) (note the little **[+]**) and a button with three dots will appear **...**. Click on it. (You can also select: **Menu → Edit → Placement**) The Tasks viewer appears.\n\n<img alt=\"\" src=images/HTCaeroplane01.png style=\"width:300px;\">\n\nIf you are unfamiliar with the XYZ axes then have a play with the numbers in the Translation box. When finished playing click on the **Reset** button.\n\n## Second Steps \n\n<img alt=\"\" src=images/HTCaeroplane02.png style=\"width:400px;\">\n\nWe are now going to rotate the cylinder so that it is lying along the X axis. To do this it needs to be rotated around the Y axis. The Rotation box should say \\'Rotation axis with angle\\' so change the Axis to Y and increment the Angle until it reaches 90. Click on **OK**.\n\nI like to play with rotating the view at this point (and often!) so by all means do so. You should find the \\'seam\\' of the cylinder on the underside.\n\n<img alt=\"\" src=images/HTCaeroplane03.png style=\"width:400px;\">\n\nWe are now going to add and modify a box so click on the <img alt=\"\" src=images/Part_Box.svg style=\"width:32px;\"> [Cube](Part_Box.md) button. Select it by clicking on Box in the Project viewer. Change the Height to 1mm, the Length to 5mm and the Width to 20mm.\n\nClick on [Placement → **...**](Placement.md) to get the Tasks viewer. Using the Translation box enter Y: -10 and Z: -1. Click on **OK**\n\nWe are now going to merge these two shapes together with a Boolean Operation. Click on the <img alt=\"\" src=images/Part_Boolean.svg style=\"width:32px;\"> [Boolean](Part_Boolean.md) button and the Tasks viewer will display the Boolean Operation selector.\n\nMake sure Union is selected, and that the Cylinder and the Box are each ticked once in the two shape lists. Click on **Apply**. Click on **Close**. You now have a single object called **Fusion**.\n\n\nLet\\'s add one more box to finish off our model. Create a Box, Select it and change its Height to 5mm, Length to 3mm and Width to 1mm. Change its Placement by Y: -0.5.\n\nWe now need to join our Fusion to Box001 so we\\'ll do it the quick way. Click on Fusion in the Project viewer and **Ctrl**+click on Box001. This selects both parts together. Now click on the <img alt=\"\" src=images/Part_Fuse.svg style=\"width:32px;\"> [Fuse](Part_Fuse.md) button to get **Fusion001**.\n\nYou should now have a simple aeroplane model. Right-click on **Fusion001** and Rename it **Aeroplane**.\n\n<img alt=\"\" src=images/HTCaeroplane04.png style=\"width:500px;\">\n\nI think the wings need to be moved forward a bit but if I select Aeroplane and try changing its Placement X Translation the whole thing moves. I only want to move the wings so cancel the Placement.\n\nExpand Aeroplane (click on the **[+]** beside it) and expand Fusion.\n\nClick on Box and get its [Placement into Tasks](Placement.md). Notice it already has Y: -10 and Z: -1 in the Translation. Change the X translation to 3 and click on **Apply**. That\\'s better. Click **OK**.\n\n\n## Rotations\n\nClick on Aeroplane and get its [Placement into Tasks](Placement.md). In the Rotation section change where it says \\'Rotation axis with angle\\' to \\'Euler angles\\' because they\\'re a lot easier to work with.\n\n**Yaw** is the rotation about the **Z axis**, that is to say a rotation from left to right. (The yaw angle is the **Psi ψ**). **Pitch** is rotation about the **Y axis**, that is to say nose-up and nose-down. (The Pitch angle is the **Phi φ**). **Roll** is rotation about the **X axis**, that is to say wing up and down. (The Roll angle is the **Thêta θ**). \n\nHowever, even here there are some important things to remember:\n\n- Positive Rotations are clockwise when viewed from the Origin outwards along a positive axis. Or to put it another way: Positive Rotations are anticlockwise when viewed from a positive axis towards the Origin.\n\n- Although the three labels are Yaw, Pitch and Roll that\\'s not really what they are. Yaw, Pitch and Roll are references to the *body coordinates* of an object in 3D space. The labels should be Heading, Elevation and Bank or even Azimuth, Inclination and Bank because they actually refer to the *space coordinates* of the 3D system. These are the **Tait-Bryan angles**. If you want more information then try [Euler Angles](http://en.wikipedia.org/wiki/Euler_angles#Tait-Bryan_angles).\n\n- With the Aeroplane in its present position simple rules apply. Yaw is rotation around the Z axis, ie left and right. Pitch is rotation around the Y axis, ie nose up and down. Roll is rotation around the X axis, ie wings up and down. That\\'s fine to start with but it\\'s not going to be true later!\n\nHave a play with the three YPR numbers. You only need to change things by a few degrees to get the idea. Reset when you finished.\n\nNow we\\'re going to see why the Yaw-Pitch-Roll labels are not really suitable. Change the Roll number to 90°. Yaw should move the nose of the aeroplane up and down and Pitch should move it side to side *as viewed from outside the aeroplane* which is where we are. Do they? No they don\\'t! Pitch changes the yaw and Yaw changes the pitch. OK, Reset.\n\nSo, a better way of thinking about rotations is that Yaw changes your Longitude, Pitch changes your Latitude and Roll changes the direction (NSEW) that you\\'re facing. Or you could check out [Axes conventions](http://en.wikipedia.org/wiki/Axes_conventions) for other descriptions.\n\nRight, back to work. Change Yaw to 45° and Pitch to -30°. Click on OK to show that the operation has been completed. Now get back the [Placement Task](Placement.md) and look at the Rotation box. It has reverted to \\'Rotation axis with angle\\' and has some wierd numbers Axis and Angle boxes. Mine had Axis: (0.219493,-0.529904,0.819161) and Angle: 53.65°. The three numbers in brackets are the XYZ components of a unit vector in the 3D space. It is the axis about which our original Aeroplane was rotated to get our final Aeroplane. The angle is how much it was rotated. Clever, huh, but not very friendly! It was Euler who showed that you could combine a series of XYZ rotations into one rotation about one axis.\n\nHere\\'s some more suggestions for playing with the Aeroplane:\n\n- Change the Z Location (and Apply) then change the YPR numbers and see what the effect is. Then try changing the X and Y Locations and rotating.\n- Change the X Centre (and Apply) then change the YPR numbers and see what the effect is. Then try changing the Y and Z Centres and rotating.\n\nI hope this little tutorial has helped you to get a feel for rotations.\n\n\n---\n⏵ [documentation index](../README.md) > [Part](Category_Part.md) > Aeroplane\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1993, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Analysis_of_reinforced_concrete_with_FEM.md", "text": "---\n TutorialInfo:\n Topic: Reinforced concrete with FEM\n Level: Intermediate\n Time: 60 minutes\n Author: User:HarryvL HarryvL, https://forum.freecadweb.org/memberlist.php?mode: viewprofile&u=18062 HarryvL\n FCVersion: 0.19 or newer\n Files: \n---\n\n# Analysis of reinforced concrete with FEM\n\n \n\n\n## Background\n\nThe [FEM Workbench](FEM_Workbench.md) has the capability of estimating the level of reinforcement required in a concrete structure to prevent brittle failure under tension or shear.\n\n <img alt=\"\" src=images/Femconcrete_Wall_3D_rx_PSS.png style=\"width:700px;\"> \n\nThis is done with the method described in [\\\"Computation of reinforcement for solid concrete\\\", P.C.J. Hoogenboom and A. de Boer, HERON Vol. 53 (2008) No. 4](http://heronjournal.nl/53-4/3.pdf). In essence, it is a post-processing routine for CalculiX, which calculates the principal tensile stresses in the concrete from an elastic analysis and uses those to determine the minimum reinforcement in the three coordinate directions required to prevent failure. In the analysis, it is assumed that the concrete material cannot carry tensile stresses, whereas the steel is utilized to its maximum capacity (i.e. reaches yield).\n\nThe required reinforcement is expressed in terms of a reinforcement ratio. This is the ratio of steel to concrete area. For example, a reinforcement ratio of 0.01 in the x direction (rx=0.01) means that the total cross-sectional area of reinforcement bars running in the x direction should be 1% of the concrete cross-sectional area they are passing through. A hypothetical cross-section of 1mx1m should in that case contain 0.01 m2 steel, which could be achieved by using 90 reinforcement bars of 12mm diameter each (steel area = 90\\*PI\\*(0.012)\\^2/4=0.0102 m\\^2). If the required reinforcement ratio over this concrete cross section is uniform then the bars could be placed at an equidistance 9x10 grid with a center-to-center distance of approximately 10cm. This is still a practical number where sufficient space between bars is left for the concrete to pass through and ensure a high-quality cover. Much higher values would lead to a very dense reinforcement grid with potential quality issues, whereas much lower values could lead to large tension cracks in the cross-section between the bars. A typical range in practice is from 0.002 to 0.02 (= 0.2% to 2%). Further guidance can be found in design codes.\n\nIf the required reinforcement ratio is not uniform over the full cross-section then the cross-section can be divided into pragmatic sub-sections with more or less uniform ratio and reinforcement applied to those cross-sections. An example will be given later on.\n\nAs a word of caution, it takes much more to design a safe and durable concrete structure than what the FEM Workbench can currently provide. For example, the method does not calculate crack width (important for durability and functionality), accurate deformations (FEM results for concrete are simply linear-elastic) or take account of reinforcement anchoring requirements (causing an increase of required reinforcement ratios in anchoring zones). It also doesn't predict concrete crushing (although an indication of that can be obtained by plotting the Mohr-Coulomb stress - see further), which could mean that the concrete fails before the reinforcement yields, causing brittle failure of the overall structure. These and other limitations mean that the FEM concrete functionality can only be used to assess conceptual designs, whereas detailed design decisions critical to safety and performance should be left to qualified professionals.\n\n## Model geometry, loads and supports \n\nAlthough the FEM concrete routine does not have any additional requirements for geometry, loads and supports, it should be borne in mind that sharp corners and supports on edges or vertices can introduce stress concentrations that will lead to extremely high and unrealistic reinforcement ratios at or near those locations.\n\n## Material Parameters \n\nFEM Workbench has a special material object for reinforced materials, which combines a matrix material (e.g. concrete) and a reinforcement material (e.g. steel). For the analysis of reinforced concrete with FEM, the following parameters need to be specified, as a minimum:\n\nfor concrete:\n\n- Young's modulus (used in the CalculiX analysis to calculate elastic deformations and stresses)\n- Poisson ratio (same)\n- uniaxial compressive strength (used during post-processing in FEM to calculate the Mohr-Coulomb stress as an indicator for crushing or shear failure in concrete)\n- friction angle (same)\n\nfor steel:\n\n- yield strength (used during post-processing in FEM to calculate reinforcement ratios)\n\nPlease note that three types of analysis are performed:\n\n1. An elastic analysis using CalculiX (only utilizing the elastic parameters for concrete)\n2. A post-processing step to analyze the required reinforcement (only utilizing the yield strength of steel)\n3. Calculation of the Mohr-Coulomb stress (only using the strength parameters of concrete, i.e. uniaxial compressive strength and friction angle). The Mohr-Coulomb stress can be reviewed in the VTK pipeline.\n\n## Application\n\nIn the remainder of this article, a few practical cases will be analyzed to discuss the application of the method.\n\n### Simply supported beam with uniform load \n\nA 4.0x0.1x0.3m concrete beam is loaded by self-weight and a 100kN (25kN/m) distributed load.\n\nThe material parameters are as follows:\n\nfor concrete:\n\n- Young's modulus = 32 GPa (as per CalculiX default for concrete)\n- Poisson ratio = 0.17 (as per CalculiX default for concrete)\n- uniaxial compressive strength = 30 MPa (concrete type C30/37)\n- friction angle = 30 degrees\n\nfor steel:\n\n- yield strength = 500 MPa\n\nThe specific weight of the concrete is taken as 24kN/m\\^3\n\nThe required reinforcement in the x direction is very high (5.4%) and exceeds the typical maximum percentages allowed by code to prevent brittle failure. The high shear stresses at the supports also lead to a requirement of high reinforcement:\n\n <img alt=\"\" src=images/Pre_Stressed_Beam_2_Weight_Load_RR_x_0.054.jpg style=\"width:700px;\"> \n\nThe Mohr-Coulomb plot shows that the beam is indeed prone to crushing on the compression side (Mohr-Coulomb stress \\> 0.0), as would be expected with a very high reinforcement percentage:\n\n <img alt=\"\" src=images/Pre_Stressed_Beam_2_Weight_Load_MC.jpg style=\"width:700px;\"> \n\nBoth the reinforcement ratio and Mohr-Coulomb stress indicate that we have an issue and that we need to rethink our conceptual design. Potential solutions are to increase the beam dimensions or use pre-stressed concrete. Further details can be found in the following post:\n\n <https://forum.freecadweb.org/viewtopic.php?f=18&t=28821&start=10#p235003> \n\n### Beam with mid-span support \n\nA 8.0x0.2x0.4m concrete beam is loaded by self-weight and a 160kN (20kN/m) distributed load.\n\nThe material parameters are as follows:\n\nfor concrete:\n\n- Young's modulus = 32 GPa (as per CalculiX default for concrete)\n- Poisson ratio = 0.17 (as per CalculiX default for concrete)\n- uniaxial compressive strength = 25 MPa (concrete type B25)\n- friction angle = 30 degrees\n\nfor steel:\n\n- yield strength = 286 MPa (reduced from 500 MPa to account for a safety factor of 1.75)\n\nThe specific weight of the concrete is taken as 24 kN/m\\^3\n\nThe ParaView plot of the exported VTK file shows that the reinforcement requirement is largest at the top of the beam near the central support. Here the highest bending moment occurs. The maximum reinforcement ratio of 0.02 is at the high end of the practical range quoted earlier:\n\n <img alt=\"\" src=images/Beam_with_Central_Support_rx_full.png style=\"width:700px;\"> \n\nThe required area of steel at the central support can be obtained with a ParaView integration filter applied to the mid-section of the beam:\n\n <img alt=\"\" src=images/CoG_Reinforcement.png style=\"width:700px;\"> \n\nThe panel at the bottom of this picture shows that the total required steel area at this cross section is 389.6 mm\\^2. As one reinforcement bar of diameter 12mm has a cross-sectional area of 113mm\\^2, it means that 4 bars would be required, giving a cross-sectional area of 452 mm\\^2. These would need to be placed near the top of the beam while maintaining sufficient concrete cover. The theoretical center of gravity for the reinforcement can be found by integration:\n\nCoG_y = Integrate (rx \\* y dy dz) / Integrate (rx dy dz)\n\nCoG_z = Integrate (rx \\* z dy dz) / Integrate (rx dy dz)\n\nThese integrals can also be determined with ParaView and give for the present case (see bottom panels in the above picture):\n\nCoG_y = 38961 / 389.6 = 100.0 mm\n\nCoG_z = 134917 / 389.6 = 346.3 mm\n\nwhich is, as expected, center-width and near the top.\n\nThe reinforcement requirement found above agrees well with that obtained using traditional methods:\n\n <https://forum.freecadweb.org/viewtopic.php?f=18&t=28821&start=20#p235063> \n\nFinally, a Mohr-Coulomb stress check should be performed to check the potential crushing of the concrete. For this check, the characteristic compressive strength of concrete (25MPa) should be divided by an appropriate material factor (\\>1.0).\n\n### Shear wall with uniform load \n\nA 4.0x2.0x0.15m wall is supported by two 0.5m wide columns. The wall is loaded by self-weight and a 1.0MN distributed load at the top.\n\nThe material parameters are as follows:\n\nfor concrete:\n\n- Young's modulus = 32 GPa (as per CalculiX default for concrete)\n- Poisson ratio = 0.17 (as per CalculiX default for concrete)\n- uniaxial compressive strength = 20 MPa\n- friction angle = 30 degrees\n\nfor steel:\n\n- yield strength = 286 MPa\n\nThe specific weight of the concrete is taken as 24 kN/m\\^3\n\nThe horizontal reinforcement ratio peaks at 0.014 (1.4%) near the bottom center section of the wall and the vertical reinforcement ratio is at a maximum 0.008 (0.8%) near the corners of the wall with the columns, where the shear stresses are highest:\n\n <img alt=\"\" src=images/Wall_3D.jpg style=\"width:1000px;\"> \n\nThe above picture shows possible zones of constant reinforcement ratio for the design of reinforcement. Although a minimum reinforcement percentage of 0.2% is chosen, it will be hard to achieve such a low value in practice, given that the spacing should not exceed a practical limit (say 300mm). Even with a light reinforcement grid of 10mm bars (cross-sectional area = 78mm\\^2), the reinforcement ratio would then be 2 \\* 78 / (150 \\* 300) = 0.0035 (0.35%). (Note: factor 2 stems from the fact that the grid will be placed at both faces of the wall). If we add one more bar to the grid (halving the distance) the reinforcement ratio would double to 0.7% and one more would give approximately 1%. So most of the reinforcement requirement could be achieved by starting with a grid of d=10mm at 300x300mm spacing and adding bars in horizontal or vertical direction, as required. This would cover all but the requirement at the bottom of the wall, where we could add 3 bars d=12mm, giving a horizontal reinforcement ratio of 3 \\* 113mm\\^2 / (150mm \\* 150mm) = 0.015 (1.5%). Here it is assumed that the height of the bottom zone is 150mm. Alternatively, we could choose 2 bars of 16mm diameter, achieving the same reinforcement ratio for a zone of 180mm height.\n\nFinally, a review of the Mohr-Coulomb stress shows that no concrete crushing is expected in the wall.\n\n <https://forum.freecadweb.org/viewtopic.php?f=18&t=28821&start=10#p234673> \n\n### Deep beam with opening \n\nThe FIB Practitioners\\' Guide to Finite Element Modelling of Reinforced Concrete Structures contains a design example of a deep concrete beam with an opening. The example is used in that report to demonstrate the \\\"Strut-and-Tie\\\" method. Here the results will be compared to those obtained with the FreeCAD FEM Workbench.\n\nThe beam dimensions are 11.0x4.0x0.6m and it is loaded at the top by a distributed load of 120kN/m and a load of 5000kN introduced by a 1m wide column. The factored compressive strength of the concrete is 0.75 x 0.6 x fc = 0.45 \\* 35 = 15.8MPa and the factored yield strength of the reinforcement steel is 315MPa.\n\nThe reinforcement ratios and principal concrete stresses (compression only) derived with FreeCAD are shown below:\n\n <img alt=\"\" src=images/FIB_Deep_Concrete_Beam_1.png style=\"width:1000px;\"> \n\nThe required horizontal reinforcement (below in red) is determined by integration of the horizontal reinforcement ratio over the vertical cuts of interest (below in black). This is done using a Paraview integration filter.\n\n <img alt=\"\" src=images/FIB_Reinforcement(2).jpg style=\"width:700px;\"> \n\nThe insert to the above figure shows a comparison of reinforcement requirements (in mm\\^2 of steel) determined with FreeCAD to those in the FIB report.\n\nThe following shows how the integration over lines of interest works in Paraview:\n\n <img alt=\"\" src=images/FIB_Reinforcement_ry.jpg style=\"width:700px;\"> \n\nFinally, a plot of compressive and tensile principal stresses to demonstrate how stresses flow through the beam.\n\n <img alt=\"\" src=images/FIB_Beam_Stresses_and_Cables.jpg style=\"width:700px;\"> \n\nThe tensile stress pattern suggests an alternative design concept using pre-stressing cables (superimposed in white). This concept is further elaborated in the following post: <https://forum.freecadweb.org/viewtopic.php?f=18&t=33049>\n\n## Related\n\n- [FEM Concrete](FEM_Concrete.md)\n\n {{FEM Tools navi}}\n\n\n---\n⏵ [documentation index](../README.md) > [FEM](Category_FEM.md) > Analysis of reinforced concrete with FEM\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 3285, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Animation_Workbench.md", "text": "# Animation Workbench\n## Introduction\n\nAnimation Toolkit for FreeCAD\n\nThis Workbench can be used to create sequences of pictures.\n\n**It is still under construction - all contributions welcomed \\...**\n\n## References\n\n- Author: [microelly2](https://github.com/microelly2)\n- Home page: [Animation](https://github.com/microelly2/Animation)\n- Source code on github: [Animation](https://github.com/microelly2/Animation)\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## Tools\n\nDetailed description [here](http://freecadbuch.de/doku.php?id=Animation%20Wokbench#the_toolset)\n\nToolbar\n\n\n\nDrop down menu\n\n- <img alt=\"\" src=images/Animation_Mover.png style=\"width:32px;\"> **Mover**: moves objects during a time intervall along the motion Vector.\n- <img alt=\"\" src=images/Animation_Rotator.png style=\"width:32px;\"> **Rotator**: rotates objects during a time intervall. Further parameters are Rotation Axis/Direction, Center of Rotation and Angle.\n- <img alt=\"\" src=images/Animation_Tranquillizer.png style=\"width:32px;\"> **Tranquillizer**: slows the render process if the animation runs to fast.\n- <img alt=\"\" src=images/Animation_Photographer.png style=\"width:32px;\"> **Photographer**: creates a picture of a given format and size to a render directory for every time step.\n- <img alt=\"\" src=images/Animation_Plugger.png style=\"width:32px;\"> **Plugger**: connects a newly created object to an already animated shuttle object or to a vertex of an animated sketch to enable using sketcher to calculate complex transformations with some constraints by means of the shuttle object.\n- <img alt=\"\" src=images/Animation_Adjuster.png style=\"width:32px;\"> **Adjuster**: enables to calculate a value by a basic linear function. Now sketches can become animated by changing values in constraints.\n- <img alt=\"\" src=images/Animation_Styler.png style=\"width:32px;\"> **Styler**: controls the Gui-object. Visibility, Transparency and Shape Color can be changed on the fly.\n- <img alt=\"\" src=images/Animation_Billboard.png style=\"width:32px;\"> **Billboard**: Billboard and Moviescreen are features to display extra information like texts or images during the animation.\n- <img alt=\"\" src=images/Animation_Moviescreen.png style=\"width:32px;\"> **Moviescreen**: Billboard and Moviescreen are features to display extra information like texts or images during the animation.\n- <img alt=\"\" src=images/Animation_Extruder.png style=\"width:32px;\"> **Extruder**: can be used to demonstrate the functionality of a miller or a 3D printer.\n- <img alt=\"\" src=images/Animation_Viewpoint.png style=\"width:32px;\"> **Viewpoint**:\n- <img alt=\"\" src=images/Animation_Manager.png style=\"width:32px;\"> **Manager**:\n- <img alt=\"\" src=images/Animation_Bounder.png style=\"width:32px;\"> **Bounder**: limits the values of the Placement to an intervall. It is the projection of a motion to a min/max limited space.\n- <img alt=\"\" src=images/Animation_Filler.png style=\"width:32px;\"> **Filler**: can be used to fill the volume of a part from bottom to top like to fill a bottle with wine. It can work as running slice trough the part like a ct scan.\n- <img alt=\"\" src=images/Animation_Gearing.png style=\"width:32px;\"> **Gearing**: animates the rotation of 2 or 3 gears or a star-planet-moon system.\n- <img alt=\"\" src=images/Animation_Kartan.png style=\"width:32px;\"> **Kartan**: animates a Kardan joint.\n- <img alt=\"\" src=images/Animation_Scaler.png style=\"width:32px;\"> **Scaler**:\n- <img alt=\"\" src=images/Animation_Placer.png style=\"width:32px;\"> **Placer**:\n- <img alt=\"\" src=images/Animation_Diagram.png style=\"width:32px;\"> **Diagram**:\n- <img alt=\"\" src=images/Animation_Collision.png style=\"width:32px;\"> **Collision**:\n- <img alt=\"\" src=images/Animation_Combiner.png style=\"width:32px;\"> **Combiner**:\n- <img alt=\"\" src=images/Animation_AnimationControlPanel.png style=\"width:32px;\"> **AnimationControlPanel**:\n- <img alt=\"\" src=images/Animation_Pather.png style=\"width:32px;\"> **Pather**:\n- <img alt=\"\" src=images/Animation_Snapshot.png style=\"width:32px;\"> **Snapshot**:\n- <img alt=\"\" src=images/Animation_ViewSequence.png style=\"width:32px;\"> **ViewSequence**:\n- <img alt=\"\" src=images/Animation_Speeder.png style=\"width:32px;\"> **Speeder**:\n- <img alt=\"\" src=images/Animation_Toucher.png style=\"width:32px;\"> **Toucher**:\n- <img alt=\"\" src=images/Animation_Tracker.png style=\"width:32px;\"> **Tracker**:\n- <img alt=\"\" src=images/Animation_Trackreader.png style=\"width:32px;\"> **Trackreader**:\n- <img alt=\"\" src=images/Animation_Abroller.png style=\"width:32px;\"> **Abroller**:\n- <img alt=\"\" src=images/Animation_Delta.png style=\"width:32px;\"> **Delta**:\n- <img alt=\"\" src=images/Animation_Sum.png style=\"width:32px;\"> **Sum**:\n- <img alt=\"\" src=images/Animation_Assembly2Controller.png style=\"width:32px;\"> **Assembly2Controller**:\n- <img alt=\"\" src=images/Animation_Connector.png style=\"width:32px;\"> **Connector**:\n\nOther\n\n- <img alt=\"\" src=images/Animation_Animation.png style=\"width:32px;\"> **Animation**:\n- <img alt=\"\" src=images/Animation_CaseAction.png style=\"width:32px;\"> **Case action**:\n- <img alt=\"\" src=images/Animation_FalseAction.png style=\"width:32px;\"> **False action**:\n- <img alt=\"\" src=images/Animation_FollowMe.png style=\"width:32px;\"> **Follow me**:\n- <img alt=\"\" src=images/Animation_LoopAction.png style=\"width:32px;\"> **Loop action**:\n- <img alt=\"\" src=images/Animation_QueryAction.png style=\"width:32px;\"> **Query action**:\n- <img alt=\"\" src=images/Animation_RepeatAction.png style=\"width:32px;\"> **Repeat action**:\n- <img alt=\"\" src=images/Animation_ScriptAction.png style=\"width:32px;\"> **Script action**:\n- <img alt=\"\" src=images/Animation_TrueAction.png style=\"width:32px;\"> **True action**:\n- <img alt=\"\" src=images/Animation_WhileAction.png style=\"width:32px;\"> **While action**:\n- <img alt=\"\" src=images/Animation_Reset.png style=\"width:32px;\"> **Reset**:\n- <img alt=\"\" src=images/Animation_Icon1.png style=\"width:32px;\"> **Icon1**:\n- <img alt=\"\" src=images/Animation_Icon2.png style=\"width:32px;\"> **Icon2**:\n- <img alt=\"\" src=images/Animation_Icon3.png style=\"width:32px;\"> **Icon3**:\n\n## Links to Animation WB \n\n- Workbench Wiki: [www.freecadbuch.de](http://freecadbuch.de/doku.php?id=Animation%20Wokbench)\n- FreeCAD Wiki:\n- FreeCAD Forum: <http://forum.freecadweb.org/viewtopic.php?t=8976&start=10>\n- Tutorials: [Toolset](http://freecadbuch.de/doku.php?id=Animation%20Wokbench#abroller)\n- Videos: [Animation videos](http://freecadbuch.de/doku.php?id=animation:videos)\n- Files: [Examples](https://github.com/microelly2/Animation-WB-Examples)\n- Test cases: [Test cases](https://github.com/microelly2/Animation/tree/master/testcases)\n- Report bugs: Please report bugs at [FreeCAD forum](http://forum.freecadweb.org/index.php), or at [Animation issues](https://github.com/microelly2/Animation/issues)\n\n## Other useful links \n\n- [ExplodedAnimation](http://www.freecadweb.org/wiki/index.php?title=Sandbox:ExplodedAnimation): FreeCAD workbench to create exploded views and animations of assemblies.\n- [Assembly2](http://www.freecadweb.org/wiki/index.php?title=Sandbox:Assembly2): Assembly workbench for FreeCAD with support for importing parts from external files.\n- [External workbenches](External_workbenches.md)\n\n\n---\n⏵ [documentation index](../README.md) > [User Documentation](Category_User%20Documentation.md) > [Addons](Category_Addons.md) > [External Workbenches](Category_External%20Workbenches.md) > Animation Workbench\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2150, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/AppImage.md", "text": "# AppImage\n## What is an AppImage? \n\n **Package once and run everywhere. Reach users on all major Linux desktop distributions.**\n\nAppImage is a \\\"universal binary package\\\" intended to distribute an application to any Linux distribution. Read more about it on the [Appimage homepage](https://appimage.org) and [Wikipedia](https://en.wikipedia.org/wiki/AppImage).\n\nTo run it, first make it executable, and then type the relative or full path.\n\n \n```python\nchmod +x FreeCAD_xxx-x86_64.AppImage\n./FreeCAD_xxx-x86_64.AppImage\n```\n\nFor other types of installation see [Download](Download.md).\n\n## FreeCAD AppImages \n\n\n Stable Development\n \n  [v1.0.0](https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/1.0.0)  [Weekly build](https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds)\n\n : style=\\\"text-align: center; font-size: 150%; \\| Available FreeCAD AppImages \\|+\n\n\n**Important Notes:**\n\n- Development happens daily and rapidly.\n- Many users on the forum utilize the development version.\n- It can be run on the same system in parallel with another version of FreeCAD.\n- Users use the dev version to take advantage of the latest features and bug fixes (since FreeCAD has a long release cycle). They also use it to help test and find bugs to spur development and improvement of FreeCAD.\n\n#### Obligatory Word of Caution \n\nFor the most part the development version is stable but of course it\\'s important to add the obligatory statement to use it at your own risk. Though most people that utilize backups and \\'save often\\' do quite well.\n\n## Automatic updating \n\nAppImage has a smart and economical way of updating. It calculates the difference between the new AppImage and the old one, and will only download the changes between their versions. In theory the user ends up downloading around 15% each time instead of an entirely new AppImage.\n\nAutomatic updating is done via several optional methods. Currently there are 4 methods, 2 through the graphical interface (GUI), and 2 through the command-line/terminal interface (CLI).\n\n### Experimental in-app updating \n\nThanks to the efforts of several key devs, there is an [ongoing effort](https://forum.freecadweb.org/viewtopic.php?f=8&t=44324) to integrate a feature that allows **self-updating the AppImage within FreeCAD** itself. Starting from FC 0.19.21514 there now exists an AppImage section found via **Edit → Preferences → AppImage**. Please test this capability and report your experience to the [forum discussion](https://forum.freecadweb.org/viewtopic.php?f=8&t=44324).\n\n### GUI method 1 (official) \n\nThis is the official AppImageUpdate GUI application.\n\n1. Download [AppImageUpdate-x86_64.AppImage](https://github.com/AppImage/AppImageUpdate/releases/download/continuous/AppImageUpdate-x86_64.AppImage).\n2. Make it executable by right clicking on the file, going in to properties and \\\"Run as an executable\\\".\n3. Double click on the AppImage icon, a dialog box will appear and you\\'ll be prompted to specify what AppImage you want to update.\n4. Specify the path to your existing AppImage.\n5. Once the AppImage is updated, press the button **Run updated AppImage**.\n\n### GUI method 2 (unofficial) \n\nThis is a sleeker 3rd-party unofficial version of AppImageUpdate named: **AppImageUpdater**. It is still in development (at the time of this wiki edit) but nevertheless, quite nice to use.\n\n1. Download [AppImageUpdater-\\*-x86_64.AppImage](https://github.com/antony-jr/AppImageUpdater/releases/tag/continuous)\n2. Make it executable: \n```pythonchmod +x AppImageUpdater*-x86_64.AppImage```\n3. Run it: \n```pythonsource AppImageUpdater*-x86_64.AppImage```\n4. Find your current FreeCAD AppImage and drag-drop it on to the AppImageUpdater\n\nResult: Follow the AppImageUpdater prompts\n\n### CLI method 1 (official) \n\nRun the following instructions in your terminal\n\n \n```python\nwget https://github.com/AppImage/AppImageUpdate/releases/download/continuous/appimageupdatetool-x86_64.AppImage\nchmod +x ./appimageupdatetool-x86_64.AppImage\n./appimageupdatetool.AppImage path/to/old/FreeCAD.AppImage\nchmod +x path/to/updated/FreeCAD.AppImage\n./path/to/updated/FreeCAD.AppImage\n```\n\nNotes:\n\n- The file names will be unique because of the version info is embedded in them. The above instructions are simplified for convenience.\n- Run `./appimageupdatetool-x86_64.AppImage --help` to learn about functionality like `--remove-old`, `--overwrite` and `--self-update`.\n- There is also an i386 version; see the [AppImageUpdate release](https://github.com/AppImage/AppImageUpdate/releases) page.\n\nTodo: share a script that can be added as an alias or [cron](https://en.wikipedia.org/wiki/Cron) job.\n\n### CLI method 2 (unofficial) \n\nSimilarly to the Graphical methods having an official and unofficial approaches to downloading AppImages, the same applies to the command line. This is a sleeker 3rd-party command line option to download AppImages.\n\n1. Download [appimageupdater-\\*-x86_64.AppImage](https://github.com/antony-jr/AppImageUpdater/releases/tag/continuous-cli)\n2. Make it executable: \n```pythonchmod +x appimageupdater*-x86_64.AppImage```\n3. Run it: \n```pythonsource appimageupdater*-x86_64.AppImage /path/to/old/FreeCAD-AppImage.AppImage```\n\n**Result**: Updates specified AppImage file if update exists\n\n# Experimental\n\n## Fixing AppImage zsync \n\nIt may happen that an AppImage won\\'t update because it\\'s target file changed in some way. Instead of downloading a whole new AppImage, it\\'s possible to rewrite the zsync file that is used by the AppImage to download the delta. More info can be found at <https://github.com/antony-jr/appimage-update-info-writer>.\n\nThis section needs more details.\n\n## Downloading via Bittorrent \n\nAn experimental feature that the FreeCAD packaging team is exploring (thanks to the work of Antony-jr) is being able to download an appimage delta of FreeCAD via bittorrent. The repository issue is at <https://github.com/FreeCAD/FreeCAD-Bundle/issues/49>\n\n# Developer Section \n\n\n**Note:**\n\nthe following sections are intended for developers\n\n## Unpacking AppImages \n\nA very convenient aspect of FreeCAD is that a majority of it is built in [Python](Python.md), which doesn\\'t need to be manually compiled like C++. Essentially, a Python file can be modified, and upon restarting FreeCAD those changes will be integrated into the application. A developer can quickly work on the latest FreeCAD release using this technique and an AppImage. Moreover, using an AppImage doesn\\'t modify your system\\'s environment in any way, that is, nothing is installed and no environmental variables are modified.\n\n### Modifying AppImages \n\nAn AppImage embeds a file system in it with everything that is required to run the application. In order to modify it, the file system needs to be extracted.\n\n \n```python\n./FreeCAD_xxx.AppImage --appimage-extract\ncd squashfs-root/\n```\n\nNow open the required Python source files in your preferred code editor, modify them, and save them. Then run the application.\n\n \n```python\n./AppRun\n```\n\n### Repackaging AppImages \n\nIf you\\'ve modified the code, and now want to re-package the AppImage with your latest changes, use the [appimagetool-x86_64](https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage) tool on the extracted file system.\n\n \n```python\ncd ..\nwget \"https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage\"\nchmod +x appimagetool-x86_64.AppImage\n./appimagetool-x86_64.AppImage squashfs-root\n```\n\n## Personalized AppImages \n\nThanks to the work of **realthunder**, author of [App Link](App_Link.md) and [Assembly3 Workbench](Assembly3_Workbench.md), it is possible to build custom AppImages using a set of scripts.\n\nThis makes it very convenient to release images for a specific branch of the source code for others to test. Although AppImages only work on Linux, realthunder\\'s scripts make it possible to generate AppImages also on Windows and MacOS.\n\nThe repository for these scripts is at [realthunder/FreeCADMakeImage](https://github.com/realthunder/FreeCADMakeImage). Please read the [Readme.md](https://github.com/realthunder/FreeCADMakeImage/blob/master/Readme.md) for more details.\n\n## Related\n\n- [Snap](Ubuntu_Snap.md) packages.\n- [Flatpak](Flatpak.md) packages.\n\n\n---\n⏵ [documentation index](../README.md) > [Packaging](Category_Packaging.md) > [Developer Documentation](Category_Developer%20Documentation.md) > [Testing](Category_Testing.md) > AppImage\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 2095, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_DocumentObject.md", "text": "# App DocumentObject\n## Introduction\n\n <img alt=\"\" src=images/Px.svg style=\"width:32px;\"> \n\nAn [App DocumentObject](App_DocumentObject.md) object, or formally an `App::DocumentObject`, is the base class of all object classes handled in the document.\n\nIn general terms, a \\\"DocumentObject\\\" is any \\\"thing\\\" that can appear in the [Tree view](Tree_view.md), and which is saved and restored when opening a document.\n\n\n\n\n*Tree view showing different objects in the document. Each of them is a \"document object\", ultimately derived from the base `App::DocumentObject* class.`\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nThe [App DocumentObject](App_DocumentObject.md) is an internal class, so it cannot be created from the graphical interface, nor is it meant to be used by itself. It just defines the basic behavior and properties of objects in the program.\n\nSome of the most important DocumentObjects are the following:\n\n- The [App FeaturePython](App_FeaturePython.md) class, an empty object that can be used for different purposes, depending on the added properties.\n- The [App GeoFeature](App_GeoFeature.md) class, the base object of all geometrical objects, that is, of objects that have a [Placement](Placement.md) property that defines their position in the [3D view](3D_view.md).\n- The [Part Feature](Part_Feature.md) class, derived from App GeoFeature, and the parent class of objects with 2D and 3D [topological shapes](Part_TopoShape.md).\n- The [Mesh Feature](Mesh_Feature.md) class, derived from App GeoFeature, and the parent class of objects with 2D and 3D [meshes](Mesh_MeshObject.md).\n\n## Properties\n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThese are the basic properties that essentially all objects have. These properties can be accessed from the [Python console](Python_console.md).\n\n- **Label|String**: the user editable name of this object, it is an arbitrary UTF8 string. By default, it is the same as the `Name`.\n\n- **Label2|String**: 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**: a list of expressions.\n\n- **Visibility|Bool**: whether to display the object or not.\n\nFor derived objects, only **Label** will be listed in the [property editor](property_editor.md) by default. The other properties will be hidden.\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 DocumentObject is created with the `addObject()` method of the document. However, in general, there is no need to create this object manually. It is usually better to subclass one of the more complex classes, for example, [App FeaturePython](App_FeaturePython.md), [App GeoFeature](App_GeoFeature.md), [Part Feature](Part_Feature.md), [Part Part2DObject](Part_Part2DObject.md), etc.\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::DocumentObject\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\n\n---\n⏵ [documentation index](../README.md) > App DocumentObject\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 816, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_DocumentObjectGroup.md", "text": "# App DocumentObjectGroup\n## Introduction\n\n <img alt=\"\" src=images/Folder.svg style=\"width:32px;\"> \n\nAn [App DocumentObjectGroup](App_DocumentObjectGroup.md) object, or formally an `App::DocumentObjectGroup`, is a simple element that allows grouping any type of [App DocumentObject](App_DocumentObject.md) in the [tree view](Tree_view.md) no matter its type of data.\n\nIt was developed to organize the objects in the [tree view](Tree_view.md) in a way that is logical for the user.\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in the program. The `App::DocumentObjectGroup* class has an extension that allows it to group any type of object; the Group itself doesn't have many properties.`\n\n## Usage\n\n1. Press the **[<img src=images/Std_Group.svg style=\"width:16px\"> [Std Group](Std_Group.md)** button in the structure toolbar. An empty Group is created.\n2. To add objects to a Group, select them in the [tree view](Tree_view.md), and then drag and drop them over the Group.\n3. To remove objects from a Group, drag them out of the Group, and onto the document label at the top of the [tree view](Tree_view.md).\n\nSee the [Std Group](Std_Group.md) page for the complete information, including its use in [Scripting](Std_Group#Scripting.md).\n\n## Properties\n\nAn [App DocumentObjectGroup](App_DocumentObjectGroup.md) (`App::DocumentObjectGroup` class) is derived from the basic [App DocumentObject](App_DocumentObject.md) (`App::DocumentObject` class), therefore it shares all the latter\\'s properties.\n\nSee the properties in the [Std Group](Std_Group.md) page.\n\n {{Std Base navi}} {{Document objects navi}}\n\n\n---\n⏵ [documentation index](../README.md) > App DocumentObjectGroup\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 436, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_FeaturePython.md", "text": "# App FeaturePython\n## Introduction\n\nAn <img alt=\"\" src=images/Feature.svg style=\"width:32px;\"> [App FeaturePython](App_FeaturePython.md) object, or formally an `App::FeaturePython`, is a simple instance of the [App DocumentObject](App_DocumentObject.md) in [Python](Python.md).\n\nThis is a simple object that by default doesn\\'t have many properties, for example it doesn\\'t have a [placement](Placement.md) or a [topological shape](Part_TopoShape.md). Depending on the properties that are assigned to it, it can be used to manage different types of data.\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nThe [App FeaturePython](App_FeaturePython.md) is an internal object, so it cannot be created from the graphical interface. It is meant to be sub-classed by classes that will handle different types of data.\n\nFor example, the [Draft Text](Draft_Text.md), [Draft Dimension](Draft_Dimension.md), and [Draft WorkingPlaneProxy](Draft_WorkingPlaneProxy.md) objects of the [Draft Workbench](Draft_Workbench.md) are `App::FeaturePython` objects with a custom icon and additional properties. They hold data but not an actual [Part TopoShape](Part_TopoShape.md).\n\nIf the desired object should have a placement, a shape, an attachment or other complex properties, it is better to create one of the more complex classes, for example, [App GeoFeature](App_GeoFeature.md), [Part Feature](Part_Feature.md), or [Part Part2DObject](Part_Part2DObject.md).\n\n## Properties\n\nSee [Property](Property.md) for all property types that scripted objects can have.\n\nThe [App FeaturePython](App_FeaturePython.md) (`App::FeaturePython` class) is derived from the basic [App DocumentObject](App_DocumentObject.md) (`App::DocumentObject` 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- **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- **Display Mode|Enumeration**: it is empty by default.\n\n- **Show In Tree|Bool**: it defaults to `True`, in which case the object will appear in the [Tree view](Tree_view.md); otherwise, the object will be hidden in the tree view. Once an object in the tree is invisible, you can see it again by opening the context menu over the name of the document (right-click), and selecting {{CheckBox|TRUE|Show hidden items}}. Then the hidden item can be chosen and **Show In Tree** can be switched back to `True`.\n\n- **Visibility|Bool**: it defaults to `True`, in which case the object will be visible in the [3D view](3D_view.md) if it has a [Shape](Part_TopoShape.md), otherwise it will be invisible. By default this property can be toggled on and off by selecting the object, and pressing the **Space** bar.\n\n\n{{TitleProperty|Selection}}\n\n- **On Top When Selected|Enumeration**: it controls the way in which the selection occurs in the [3D view](3D_view.md) if the object has a [Shape](Part_TopoShape.md), and there are many objects partially covered by others. It defaults to {{value|Disabled}}, meaning that no special highlighting will occur; {{value|Enabled}} means that the object will appear on top of any other object when selected; {{value|Object}} means that the object will appear on top only if the entire object is selected in the [Tree view](Tree_view.md); {{value|Element}} means that the object will appear on top only if a subelement (vertex, edge, face) is selected in the [3D view](3D_view.md).\n\n- **Selection Style|Enumeration**: it controls the way the object is highlighted if it has a [Shape](Part_TopoShape.md). If it is {{value|Shape}}, the entire shape (vertices, edges, and faces) will be highlighted in the [3D view](3D_view.md); if it is {{value|BoundBox}} a bounding box will appear surrounding the object and will be highlighted.\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\nAn App FeaturePython is created with the `addObject()` method of the document.\n\n \n```python\nimport FreeCAD as App\n\ndoc = App.newDocument()\nobj = App.ActiveDocument.addObject(\"App::FeaturePython\", \"Name\")\nobj.Label = \"Custom label\"\n```\n\n\n---\n⏵ [documentation index](../README.md) > App FeaturePython\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1252, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_Link.md", "text": "# App Link\n## Introduction\n\n<img alt=\"\" src=images/Link.svg style=\"width:32px;\">\n\nAn [App Link](App_Link.md), or formally an `App::Link`, is a type of object that references or links to another object, in the same document, or in another document. It is especially designed to efficiently duplicate a single object multiple times, which helps with the creation of complex [assemblies](assembly.md) from smaller subassemblies, and from multiple reusable components like screws, nuts, and similar fasteners.\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nSee [Std LinkMake](Std_LinkMake#Usage.md).\n\n## Properties\n\nSee [Std LinkMake](Std_LinkMake#Properties.md).\n\n\n---\n⏵ [documentation index](../README.md) > App Link\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 196, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_OriginGroupExtension.md", "text": "# App OriginGroupExtension\n## Introduction\n\nAn [App Origin](App_OriginGroupExtension.md) object, or formally an `App::OriginGroupExtension`, is a class supplying selectable elements that represent the three standard axes (X, Y, Z) and three standard planes (XY, XZ and YZ) to objects that are intended to arrange different types of geometry in space.\n\n<img alt=\"\" src=images/Std_Part.svg style=\"width:16px;\"> [Std Part](Std_Part.md) [(App Part)](App_Part.md) objects and <img alt=\"\" src=images/PartDesign_Body.svg style=\"width:16px;\"> [PartDesign Body](PartDesign_Body.md) objects are created with Origin objects by default. If needed, Origin objects can be added to <img alt=\"\" src=images/Assembly_Assembly_Tree.svg style=\"width:16px;\"> [Assembly](Assembly3_CreateAssembly.md) objects of the <img alt=\"\" src=images/Assembly3_workbench_icon.svg style=\"width:16px;\"> [Assembly3](Assembly3_Workbench.md) workbench, too.\n\n <img alt=\"Tree view\" src=images/App_OriginGroupExtension_example.png style=\"width:200px;\"> <img alt=\"3D view\" src=images/App_OriginGroupExtension-02.png style=\"width:400px;\"> \n*Left: The [tree view](Tree_view.md) showing three objects that use Origin objects. Right: Representation of the Origin elements in the [3D view](3D_view.md).*\n\nThe axes and planes are objects of type `App::Line` and `App::Plane` respectively. Each of these elements can be hidden and unhidden individually with the **Space** bar. This can be useful when selecting the correct reference for creating other objects e.g. [Sketches](Sketch.md).\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in the program. Two of them have an Origin object to control the placement of the objects grouped under them.*\n\n\n---\n⏵ [documentation index](../README.md) > App OriginGroupExtension\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 463, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/App_Part.md", "text": "# App Part\n## Introduction\n\n <img alt=\"\" src=images/Geofeaturegroup.svg style=\"width:32px;\"> \n\nAn [App Part](App_Part.md) object, or formally an `App::Part`, is an element that allows grouping objects in 3D space.\n\nIt was developed to be used in assemblies, as it has an **Origin** which serves as the positional reference for the grouped objects.\n\n<img alt=\"\" src=images/FreeCAD_core_objects.svg style=\"width:800px;\">\n\n\n*Simplified diagram of the relationships between the core objects in FreeCAD*\n\n## Usage\n\nSee [Std Part](Std_Part#Usage.md).\n\n## Properties\n\nSee [Std Part](Std_Part#Properties.md).\n\n\n---\n⏵ [documentation index](../README.md) > App Part\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 167, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Appimage.md", "text": "# Appimage\n1. REDIRECT [AppImage](AppImage.md)\n\n\n---\n⏵ [documentation index](../README.md) > Appimage\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 33, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_3Views.md", "text": "---\n GuiCommand:\n Name: Arch 3Views\n MenuLocation: Arch , Utilities , 3 Views from mesh\n Workbenches: Arch_Workbench\n SeeAlso: Arch_SplitMesh, Arch_MeshToShape\n---\n\n# Arch 3Views\n\n## Description\n\n\n**This command is currently not in use.**\n\nIt will serve to generate flat, shape-based views from a [Mesh](Mesh_Workbench.md) based object, to be used by the **<img src=\"images/Arch_Equipment.svg\" width=24px> [Arch Equipment](Arch_Equipment.md)** tool.\n\n## Usage\n\n1. Select a Mesh object.\n2. Select the **<img src=\"images/Arch_3Views.svg\" width=16px>** button, or **Arch** → **Utilities** → **<img src=\"images/Arch_3Views.svg\" width=16px> [3Views](Arch_3Views.md)** from the top menu.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThis tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function: \n```python\nshape = createMeshView(obj, direction=FreeCAD.Vector(0, 0, -1), outeronly=False, largestonly=False)\n```\n\n- Creates a flat `shape` that is the projection of the given mesh object (`obj`) in the given `direction`.\n- If `outeronly` is `True` only the outer contour is taken into consideration, discarding the inner holes.\n- If `largestonly` is `True` only the largest segment of the given mesh will be used.\n\nUse `Part.show()` to display the resulting flat shape.\n\nExample: \n```python\nimport FreeCAD, Draft, Arch, Mesh, MeshPart\n\nLine = Draft.makeWire([FreeCAD.Vector(0, 0, 0), FreeCAD.Vector(2000, 2000, 0)])\nWall = Arch.makeWall(Line, width=150, height=3000)\nFreeCAD.ActiveDocument.recompute()\n\nShape = Wall.Shape.copy(False)\nShape.Placement = Wall.getGlobalPlacement()\n\nmesh_obj = FreeCAD.ActiveDocument.addObject(\"Mesh::Feature\", \"Mesh\")\nmesh_obj.Mesh = MeshPart.meshFromShape(Shape=Shape, MaxLength=520)\nmesh_obj.ViewObject.DisplayMode = \"Flat Lines\"\nFreeCAD.ActiveDocument.recompute()\n\nXAxis = FreeCAD.Vector(1, 0, 0)\nYAxis = FreeCAD.Vector(0, 1, 0)\nZAxis = FreeCAD.Vector(0, 0, -1)\n\ns1 = Arch.createMeshView(mesh_obj, ZAxis)\ns2 = Arch.createMeshView(mesh_obj, XAxis)\ns3 = Arch.createMeshView(mesh_obj, YAxis)\n\nPart.show(s1)\nPart.show(s2)\nPart.show(s3)\n\nWall.ViewObject.Visibility = False\nmesh_obj.ViewObject.Visibility = False\n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch 3Views\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 678, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_API.md", "text": "# Arch API\n**(November 2018) The Arch API is listed in the [https://www.freecadweb.org/api autogenerated API documentation].**\n\nThe functions of the API are part of the [Arch Workbench](Arch_Workbench.md) and can be used in [macros](Macros.md) and from the [Python](Python.md) console once the `Arch` module has been imported. The [Reinforcement Workbench](Reinforcement_Workbench.md) has its own [Reinforcement API](Reinforcement_API.md).\n\nExample: \n```python\nimport FreeCAD, Draft, Arch\n\np1 = FreeCAD.Vector(0, 0, 0)\np2 = FreeCAD.Vector(2000, 0, 0)\nbaseline = Draft.makeLine(p1, p2)\n\nArch.makeWall(baseline, length=None, width=200, height=2000)\n```\n\n\n---\n⏵ [documentation index](../README.md) > [API](Category_API.md) > [Poweruser_Documentation](Category_Poweruser_Documentation.md) > [BIM](Category_BIM.md) > Arch API\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 240, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_Add.md", "text": "---\n GuiCommand:\n Name: Arch Add\n MenuLocation: Modify , Add component\n Workbenches: BIM_Workbench\n SeeAlso: Arch_Remove\n---\n\n# Arch Add\n\n## Description\n\nThe Add tool allows you to do 4 kinds of operations:\n\n- Add [shape](Part_Workbench.md)-based objects to an Arch component, such as a **<img src=\"images/Arch_Wall.svg\" width=16px> [wall](Arch_Wall.md)** or **<img src=\"images/Arch_Structure.svg\" width=16px> [structure](Arch_Structure.md)**. These objects make then part of the Arch component, and allow you to modify its shape but keeping its base properties such as width and height\n- Add Arch components, such as a **<img src=\"images/Arch_Wall.svg\" width=16px> [Arch Walls](Arch_Wall.md)** or **<img src=\"images/Arch_Structure.svg\" width=16px> [Arch Structures](Arch_Structure.md)**, to a group-based arch object such as **<img src=\"images/Arch_Floor.svg\" width=16px> [Arch Floors](Arch_Floor.md)**.\n- Add **<img src=\"images/Arch_Axis.svg\" width=16px> [Axis systems](Arch_Axis.md)\n** to **<img src=\"images/Arch_Structure.svg\" width=16px> [structural objects](Arch_Structure.md)**\n- Add objects to **<img src=\"images/Arch_SectionPlane.svg\" width=16px> [section planes](Arch_SectionPlane.md)\n**\n\nThe counterpart of this tool is the **<img src=\"images/Arch_Remove.svg\" width=16px> [Arch Remove](Arch_Remove.md)** tool.\n\n <img alt=\"\" src=images/Arch_Add_example.jpg style=\"width:640px;\"> \n*A box added to a wall as a component.*\n\n## Usage\n\n1. Select the objects to be added together. The last object selected will be the host Arch object.\n2. Press the **<img src=\"images/Arch_Add.svg\" width=16px> [Add component](Arch_Add.md)** button, or use **Modify → <img src=\"images/Arch_Add.svg\" width=16px> Add component** from the top menu.\n\n## Scripting\n\n\n**See also:**\n\n[Arch API](Arch_API.md) and [FreeCAD Scripting Basics](FreeCAD_Scripting_Basics.md).\n\nThe Add tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function: \n\n: \n \n```python\n addComponents(objectsList, host)\n \n```\n \n\n\n: The above code snippet adds the given objects in `objectsList` to the given `host` object.\n: **Note:** `objectsList` can be a single object or a list of objects.\n\nExample:\n\n \n```python\nimport FreeCAD, Arch, Draft, Part\n\np1 = FreeCAD.Vector(0, 0, 0)\np2 = FreeCAD.Vector(2000, 2000, 0)\n\nLine = Draft.makeWire([p1, p2])\nWall = Arch.makeWall(Line, width=150, height=2000)\n\np3 = FreeCAD.Vector(0, 2000, 0)\np4 = FreeCAD.Vector(3000, 0, 0)\n\nLine2 = Draft.makeWire([p3, p4])\nWall2 = Arch.makeWall(Line2, width=150, height=2000)\nFreeCAD.ActiveDocument.recompute()\n\nArch.addComponents(Wall2, Wall)\nFreeCAD.ActiveDocument.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch Add\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 811, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_Axis.md", "text": "---\n GuiCommand:\n Name: Arch Axis\n MenuLocation: Annotation , Axis\n Workbenches: BIM_Workbench\n Shortcut: **A** **X**\n SeeAlso: Arch_AxisSystem, Arch_Grid\n---\n\n# Arch Axis\n\n## Description\n\nThe **<img src=\"images/Arch_Axis.svg\" width=16px> [Arch Axis](Arch_Axis.md)** tool allows you to place a series of axes in the current document. The distance and the angle between axes is customizable, as well as the numbering style. The axes serve mainly as references to snap objects onto, but can also be used together with **<img src=\"images/Arch_AxisSystem.svg\" width=16px> [Arch AxisSystems](Arch_AxisSystem.md)**. They can also be referenced by other Arch objects to create parametric arrays, for example of beams or columns. **<img src=\"images/Arch_Grid.svg\" width=16px> [Arch Grids](Arch_Grid.md)** can also be used in places of axes.\n\n <img alt=\"\" src=images/Arch_Axis_example.jpg style=\"width:600px;\"> \n*Two axes objects positioned perpendicularly to each other to create a grid*\n\n## Usage\n\n1. Press the **<img src=\"images/Arch_Axis.svg\" width=16px> [Axis](Arch_Axis.md)** button, or press **A** then **X** keys.\n2. [Move](Draft_Move.md)/[rotate](Draft_Rotate.md) the axes system to the desired position.\n3. Enter edit mode by double-clicking the axes system in the tree view to adjust its settings like number of axes, distances and angles between axes.\n\n## Options\n\n- Each axis in the series has its own distance and angle in relation to the previous axis. This allows to do very complex systems such as non-orthogonal systems, polar systems or any kind of non-uniform system.\n- Double-clicking the axis in the tree view allows to edit the distances, angles and labels of each axis.\n- Axes length, size of the bubbles and numbering styles are customizable directly via the axes system\\'s properties.\n- Each axis can also display a label, which is editable via the task panel dialog.\n\n## Properties\n\n- **Length**: The length of the axes\n\n- **Limit**: If greater than zero, each axis will be represented as two lines of the given length instead of one continuous line <small>(v0.20)</small> \n\n- **Bubble Size**: The size of the axis bubbles\n\n- **Numeration style**: How the axes are numbered: 1,2,3, A,B,C, etc\\...\n\n- **Bubble Position**: Where the bubble is placed on the axis: At start point, endpoint, both or none.\n\n- **Font Name**: A font to draw the bubble number and/or labels\n\n- **Font Size**: The size of the label text only (bubble text is controlled by the bubble size)\n\n- **Show Labels**: Turns the display of the label texts on/off\n\n## Use as section mark \n\nBy setting the **Bubble Position** property to **Arrow left/right** or **Bar left/right**, the axis will display a filled arrow or bar instead of the bubble, so it can be used as a section mark. <small>(v0.20)</small> \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 Axis tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function:\n\n \n```python\nAxes = makeAxis(num=5, size=1000, name=\"Axes\")\n```\n\n- Creates an `Axes` object from the given number (`num`) of axes, and `size`, the interval between each axis.\n\nExample:\n\n \n```python\nimport Draft, Arch\n\nAxes = Arch.makeAxis(5, 1000)\n\nAxes.ViewObject.LineWidth = 3\nAxes.ViewObject.BubbleSize = 200\nAxes.ViewObject.FontSize = 150\n\nAxes2 = Arch.makeAxis(6, 500)\n\nAxes2.ViewObject.LineWidth = 2\nAxes2.ViewObject.BubbleSize = 200\nAxes2.ViewObject.FontSize = 150\nAxes2.ViewObject.NumberingStyle = \"A,B,C\"\nFreeCAD.ActiveDocument.recompute()\n\nAxes2.Length = 6000\nDraft.rotate(Axes2, -90)\nDraft.move(Axes2, FreeCAD.Vector(-1000, 2500, 0))\nFreeCAD.ActiveDocument.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch Axis\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 1011, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_AxisSystem.md", "text": "---\n GuiCommand:\n Name: Arch AxisSystem\n MenuLocation: Annotation , Axis System\n Workbenches: BIM_Workbench\n SeeAlso: Arch_Axis, Arch_Grid\n---\n\n# Arch AxisSystem\n\n## Description\n\nThe [AxisSystem](Arch_AxisSystem.md) tool allows you to combine two or three [Arch Axis](Arch_Axis.md) objects.\n\nThis is useful to define the intersection points between the different axes. Arch objects can then use this system to duplicate their shape on the different intersection points.\n\n <img alt=\"\" src=images/Arch_AxisSystem_example.jpg style=\"width:600px;\"> \n*Three [Arch Axis](Arch_Axis.md) objects combined into one [Arch AxisSystem](Arch_AxisSystem.md). An [Arch Structure](Arch_Structure.md) object uses this system as its **Axis* property, to have its shape duplicated at each intersection point.**\n\n## Usage\n\n1. Optionally, select the [Arch Axis](Arch_Axis.md) objects you wish to include in this system.\n2. Press the **<img src=\"images/Arch_AxisSystem.svg\" width=16px> [Axis System](Arch_AxisSystem.md)** button.\n3. Right-click the newly created axes system object in the tree view to add/edit the [Arch Axis](Arch_Axis.md) objects included in this system.\n4. Select any existing [Arch Axis](Arch_Axis.md) and press **<img src=\"images/Arch_Add.svg\" width=16px> [Add](Arch_Add.md)** or **<img src=\"images/Arch_Remove.svg\" width=16px> [Remove](Arch_Remove.md)** buttons to add or remove it to/from this system.\n5. Set the **Axis** property of any Arch object to point to this system, to have its shape duplicated to the intersection points of this system.\n\n## Options\n\n- A same [Arch Axis](Arch_Axis.md) object can be part of more than one system\n- Any shape-based object can also be used as the **Axis** property of Arch objects. In this case, the object shape will be duplicated along the vertices of the Axis object\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 AxisSystem tool can be used in [macros](Macros.md) and from the [Python](Python.md) console by using the following function: \n```python\nAxisSystem = makeAxisSystem(axes, name=\"Axis System\")\n```\n\n- Creates an `AxisSystem` object from the given `axes`, which is a single [Arch Axis](Arch_Axis.md), or a list of them.\n\nExample: \n```python\nimport Draft, Arch\n\nAxes = Arch.makeAxis(5, 1000)\n\nAxes.ViewObject.LineWidth = 3\nAxes.ViewObject.BubbleSize = 200\nAxes.ViewObject.FontSize = 150\n\nAxes2 = Arch.makeAxis(6, 500)\n\nAxes2.ViewObject.LineWidth = 2\nAxes2.ViewObject.BubbleSize = 200\nAxes2.ViewObject.FontSize = 150\nAxes2.ViewObject.NumberingStyle = \"A,B,C\"\nFreeCAD.ActiveDocument.recompute()\n\nAxes2.Length = 6000\nDraft.rotate(Axes2, -90)\nDraft.move(Axes2, FreeCAD.Vector(-1000, 2500, 0))\nFreeCAD.ActiveDocument.recompute()\n\nAxisSystem = Arch.makeAxisSystem([Axes, Axes2])\n\nStructure = Arch.makeStructure(length=200, width=200, height=100)\nDraft.move(Structure, FreeCAD.Vector(-100, 0, 0))\nStructure.Axis = AxisSystem\nFreeCAD.ActiveDocument.recompute()\n```\n\n\n---\n⏵ [documentation index](../README.md) > [BIM](Category_BIM.md) > Arch AxisSystem\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 825, "license": "CC0-1.0", "author": "Open-source contributors"} | |
| {"id": "freecad-docs:wiki/Arch_BimServer.md", "text": "# Arch BimServer\n1. REDIRECT [WebTools_BimServer](WebTools_BimServer.md)\n\n\n---\n⏵ [documentation index](../README.md) > Arch BimServer\n", "source": "freecad-docs", "added": "2026-11-08", "created": "", "token_count": 43, "license": "CC0-1.0", "author": "Open-source contributors"} | |