Macros recipes/en

This page contains macros that add functionality to a FreeCAD installation.

If you wrote a macro, and want to include it in the categories in this page, see macro documentation to learn about properly documenting the macro.

[[File:Part_CheckGeometry.svg]] 3D View operations

 * : This macro rotates the current view by 90° to the left. Only works if you are in [[Image:View-top.svg|Std_ViewTop|16px|link=Std_ViewTop]] XY (top) view.
 * : This macro rotates the current view in ViewAxonometric.
 * : This macro is used in the Python console and rotates the current view in the angle and plane given.
 * : Provides a GUI to permit rotation of view by precise amounts in all three directions.
 * : This macro allows you to temporarily put a texture image on the selected objects.
 * : This small macro turns the arrow of the mouse in a precision cross.
 * : This macro translates the Placement of an object so that a selected location becomes its new origin.
 * : This macro aligns the current view to a selected face.
 * : This macro align the selected object to the current View and set the coordinates Placement of the camera.
 * : This macro aligns the camera to the current Draft Working Plane
 * : This macro moves the current Draft Working Plane to the center of the current view
 * : This macro align the face of the selected object to the current View (in case face hole the hole is placed to the view).
 * : This macro toggles the visibility of various supporting panels in FreeCAD, allowing the main window to be viewed with all available screen space.
 * : This macro can rotate the screen in a defined angle and the defined axis and creates a plan to face the screen to create a form in the specified plan positions the selected face facing the screen, to detect the position of the camera.
 * : Set of three macro, macro 1: hidden the objects not selected, macro 2: displayed alls objects, macro 3: hidden alls objects.
 * : This macro check visible all object in the document (Visibility=True).
 * : This macro check hidden all object in the document (Visibility=False).
 * :All object not selected hare deletted !!.
 * : Set of two macro, macro 1:Macro_Toggle_Visibility2_1-2 hidden the objects not selected, macro 2:Macro_Toggle_Visibility2_2-2 displayed alls objects, macro with the original visibility.
 * : Set of two macro, macro 1:Macro_Toggle_Visibility2_1-2 hidden the objects not selected, macro 2:Macro_Toggle_Visibility2_2-2 displayed alls objects, macro with the original visibility.
 * : All visible objects in the tree will be selected.
 * : This pair of macros allow you to alter the Navigation Style to 'CAD'.
 * : This pair of macros allow you to alter the Navigation Style to 'Inventor'.
 * : This macro testing if one selection are duplicate, select the object IN THE 3D VIEW the "ForbiddenCursor" stay if the or one selection is duplicate, the macro stay resident.
 * : Copy contents of 3DView resized 640, 480 px to clipboard.
 * : This macro positioned your object perpendicularly to wire selected.
 * : Macro for rotate on object on itself with the axis of rotation the boundbox center, center of mass or last point clicked
 * : this macro select a choice Face, Edge, Vertex hovering by the mouse.
 * : this macro expand selected items in the tree view.. If not selection all item are expand/collapse
 * : this macro display all elements below cursor (elements covered by other elements will also be displayed)
 * : this macro display all elements below cursor same "Macro Mouse over cb" with GUI (elements covered by other elements will also be displayed)
 * : Special macro for the Wiki Worker. This macro allows to save the 3D view in the desired format. The 3D view or the full 3D window of FreeCAD takes the desired dimensions.
 * : This macro resets the position of the toolbars.
 * : 1:1 Zoom so objects appear their actual size on the screen.
 * [[Image:Text-x-python.png|24px]] setTextures: Allows to permanently store the URL of textures in a FreeCAD project and load stored textures.

[[File:Draft_FlipDimension.svg]] Animation

 * : Animate your model by animating its properties with this feature python object.
 * : Rotation rod and piston.
 * : Simulation of one spring.
 * : Open and close hinge.
 * : Assembly animate.
 * : Animate angle constrain in sketcher.
 * : Simulation of movements of a 3D printer.
 * : Simple example animation Draft wires by use the Expressions for associate many wires and simulate or verify the movement. Here the circle rotation create the movement for all objects connected (This macro run with FreeCAD version 0.16).

[[File:Applications-python.svg]] Code and Scripting

 * : extends the capabilities of FreeCAD's integrated Python editor.
 * : shows how to give information to the user through the GUI.
 * : example of using Qt commands, their connections, extraction and data assignment.
 * : This macro provides a cut/copy/paste workspace for Python code, it is segmented so different sections can be selected and it is persistent between FreeCAD sessions.
 * : This macro provides a utility to assemble a project from sub-project files using the Merge Project facility.
 * : This macro facilitates the user selecting global variables and monitoring their values.
 * : creates a copy of each selected object and sets its properties to an expression linking to the original object, making it an explicit and editable clone.
 * [[Image:Text-x-python.png|24px]] scanObjects: inspection tool for FreeCAD macro development and project debug.


 * : This macro is only used by programmers Test characters ASCII over 127.

[[File:Arch_MeshToShape.svg]] Conversion

 * : Extracts boundary wires from selected meshes
 * : converts selected meshes to parts
 * : Converts selected parts to VRML meshes for small size and faster loading (VRML models Kicad and Blender compatible)
 * : Converts the selected Face to a single Sketch without constraints.
 * : Import Black and White BMP images into FreeCAD as sketch, wire, or solid or Grayscale BMP for lithophanes.
 * : This macro create boolean operation with the objects selected just select the wires give the thickness and click "Create"
 * : Make a compound out of a part with a copy of all its shapes.
 * : MultiCopy allows the duplication (copy and paste) of multiple FreeCAD objects that can be labelled sequentially and in a custom manner.
 * : Imports a 3DXML-ascii file into FreeCAD, limited functionality.
 * : Imports an iges file with entity 128, for example an iges-file from FreeShip, into FreeCAD.

[[File:Drawing-orthoviews.svg]] Drawing Workbench
The Drawing Workbench is considered obsolete since FreeCAD 0.17. Consider using the TechDraw Workbench instead.


 * : allows the user to get the view of his object in a drawing with 4 different position (front,top,iso,right). Needs some modification to be perfectly effective
 * : This GUI macro to fill simply all fields of the cartridge of the plan implementation worksheet FreeCAD, the format of the date and the symbol of the projection mode adapt to the EU region or US selected.
 * : This GUI macro to fill simply all fields of the cartridge templates_Full of the plan implementation worksheet FreeCAD, the format of the date and the symbol of the projection mode adapt to the EU region or US selected.
 * : This GUI macro to fill simply all fields of the cartridge model 2 of the plan implementation worksheet FreeCAD.
 * : Get the normal vector of a preselected face for creating a drawing view normal to that face

[[File:Draft_BSpline.svg]] Dxf 2D Draft

 * : creates a parametric rectellipse
 * : creates a circle on 3 selected points, the points can be objects (this example brings together the two examples below, all parameters simply settle on a graphic window).
 * : creates a circle from 3 selected points 2D orthogonal
 * : creates a circle from 3 selected points in the space 3D
 * : creates a arc from 3 selected points
 * Makes an ellipse by selecting three points (in this order): centre, major radius and minor radius
 * : this macro convert the object line, wire in line Dash, DashDot, DashDotDot,ZigZag and Hand with the dimensions given.
 * : Converts the selected Edges to a circular Arc if possible. Useful for restoring discretized arcs.
 * : This macro create face from a DXF file, the "Layer" are recognized separate and trained in groups.
 * : This macro converts selected elements of imported dxf to face and sketch.
 * : Draf command set in a small macro for the 2D sketch example: work with the DXF files.
 * : Macro utility for create unique wire with many wires, the type wire created is selected to MakeWire, Bspline, BsplineCurve, BsplineCurve + Arc, Polygon, Bezier curve

[[File:Fem_ResultDisplacement.svg]] Fem

 * : Create FEM Meshes by GMSH Mesh Generator
 * : This macro exports multiple FEM result objects from a transient analysis to the VTK format and generates a PVU file which can be used to load the results directly into ParaView for post-processing.

[[File:Part_Measure_Clear_All.svg]] Info and measures

 * : Finds the intersection between 2 or 3 selected edges/faces, works with Datum Planes and Datum Lines also. Creates a parametric feature python object containing the shape of the intersection.
 * : Gives a series of information about the selected shape and can display a conversion of length, inclination (degrees, radian, grade) shape, surface, volume and the weight of the form in the density selected in various international and Anglo-Saxon units
 * : Gives a series of information about the selected shape as FCInfo in a mini ToolBar
 * : same as above, but for Linux (obsolete)
 * : Gives a series of information about the selected shape and displayed in screen 3D
 * : Provide informations coordinates, length and angles in real time on the mouse in a bubble annotation displayed in the 3D screen
 * : Gives the Delta values and the distance between 2 points
 * : User-friendly "Info" module created by a FreeCAD user
 * : This macro generates a listing of all objects in the current document - the list can be in a window or on the Report view.
 * : Compute the radius of a circle by 3 points or a circular edge.
 * : Gives the total mass and the center of mass of multiple objects selected with the density chosen.
 * : Display in a concise way basic physical properties of an object (volume, bound box dimensions, ...)

[[File:Draft_VisGroup.svg]] Libraries

 * : This macro creates a screw with or without thread, according to ISO standards (screw_maker1_6.py.zip with Pyside support). (Screw Maker 2.0 - new version!)
 * : The aim of BOLTS is to build a free and open-source standard parts library for CAD applications.
 * : Starts the Parts library browser

[[File:Bound-expression.svg]] Mathematical functions
equations.
 * : Feature python update of Macro 3D Parametric Curve.
 * : Draw a function described by parametric equations x(t), y(t) and z(t).
 * : draws a function described by an equation z=F(x)
 * : Based on the above macro, but for parametric and optionally polar
 * : Tool utility : Tab > Wire > Curves And Surfaces

[[File:IFC.svg]] Multifunctional

 * : Tool utility to create plans of the axes, planes from 3 points, axes on a form, information on the coordinates of the shape and many other useful features to facilitate the creation of your project. This utility is up next in the combo view.

[[File:Workbench_Image.svg]] Object creation

 * : creates a rectangular cuboid from 4 points
 * : creates a solid by sweeping a 2D profile along a trajectory previously selected in the 3D view. The 2D elements can be created through the regular tools in FreeCAD's GUI.
 * : This macro creates a geodesic dome shell
 * : This macro creates a parametric pyramid. All parameters are customizable just like with Part Cone.
 * : This macro creates parametric polyhedrons (dodecahedron, icosahedron, tetrahedron, ...). Customizable via radius or side.
 * : Create a line giving coordinate XYZ length and angle to plane X Y
 * : Cut a line and create x points, giving the number of points, create line or not, create points or not, create bicolor or not on choice.
 * : Create a circle or arc giving radius, diameter, circumference, area, startangle, endangle, arc, anglecenter, cord, arrow, center (point) on choice (same below but with GUI) plus create sector and face.
 * : Create a circle or arc giving radius, diameter, circumference, area, startangle, endangle, arc, anglecenter, cord, arrow, center (point) on choice (same above without GUI).
 * : Cut a circle or arc and create x arcs, giving the number of cut.
 * : This macro create one triangle creates a triangle by giving the head angle and the height of the triangle (the triangle of the head is positioned to the xyz coordinates 0.0)
 * : Create a project from a bmp image to create a texture easily
 * : Create a loft with a list of wire (specially created for Macro Texture see above)
 * : This macro create a text around a cylinder
 * : This macro creates a Wire with the coordinates extracted from a file. The coordinates X Y Z are separated by a space.
 * : This macro reproduce all element selected subobject wire or face.
 * : A GUI dialog that creates an Apothem, (inradius) Based Prism from user input.
 * : This macro create one spring truncate, the troncature is adjustable on the all coil to choice.
 * : This macro create one spring (helix) on the surface of the object (solide).
 * : Guitar Fretboard Maker
 * : Guitar Nut Maker
 * : Creates grooved cylinder for cam.
 * : creates an Arch Site from a series of contour lines
 * : Creates parametric honeycomb grid.
 * : Creates a feature python Honeycomb object compatible in and out of PartDesign.
 * : Creates an Hilbert curve wire in 2 or 3 dimensions with many iterations.
 * : AeroFoil creates airfoil curves and faces using pre-defined models, algebraic functions, and DAT or CSV Files.

[[File:Workbench_PartDesign.svg]] Object transformation

 * : copies the selected object several times, on an array grid.
 * : bevels selected vertices, creates parametric feature python object, compatible with all solids (except with round edges) including features in Part Design bodies.
 * : flattens draft wires that are not planar to their median Z coordinate.
 * : flattens draft wires that are not planar to a plane defined by 3 points.
 * : allows to find and joint all non connected edge to the closest non connected one using a line.
 * : removes all parametric associativity from an object, leaving it as a "dumb" shape.
 * : Forces the creation of a Wire from lines and arcs that don't necessarily touch each other. Use this if normal wire operation fails.
 * : Sometimes arcs are transformed into BSplines, for example when scale operations have been applied to them. This macro recreates valid arcs from them. Useful before exporting to dxf.
 * : Creates a clone of the object and the converted in the chosen position and size (inch, mm, m, µm...). The base object is recognized in mm (FreeCAd base).
 * : Macro for easy scaling drawings, graphics, diagram, blueprint and similar 2D images in Image workbench.
 * : Macro that provides parametric defeaturing inside and outside the PartDesign Workbench.
 * : apply linear space transformations to distort shapes. E.g., non-uniform scaling, shearing, mirroring, axes swapping.
 * : This macro easily creates a connection between two objects, an object and a point or between two points or the selected line, wire, edge (the center of the objects are the starting and ending points of the sweep) can be selected form a configurable ellipse polygon circle.
 * : (parametric): alternative implementation of Part Section tool, more suitable for making sweep paths.
 * : (parametric): Boolean operation. Similar to Part Common, but with custom overlap count threshold.
 * : Filter wires from a sketch to only use certain ones, also 2D offsets, scales, rearranges wire order.
 * : Easily set colors of faces, edges, and vertices, including individual transparency levels.

[[File:Workbench_PartDesign.svg]] PartDesign Workbench

 * : Encapsulates non-PartDesign solids for use in PartDesign Bodies, and more.

[[File:View.svg]] Printer 3D

 * : Exports current design to slicer software or CAM software.
 * : This code, when run, will export the visible bodies at the top level (bodies deeper in the tree will be ignored) of the currently open design to individual STL files, and open them it in the slicing software that you use. This macro will look for Cura as the default but you can change it to any other slider by changing the SLICERAPP variable in the source code.

[[File:Preferences-raytracing.svg]] Raytracing

 * : Export from FreeCAD to Kerkythea

[[File:Spreadsheet.svg]] Spreadsheet Workbench

 * : helps managing aliases inside FreeCAD Spreadsheet workbench. It is able to create, delete, move aliases and create a 'part family' group of files.
 * : Quickly create aliases in FreeCAD Spreadsheet workbench. It uses the labels from one column to create aliases for adjacent cells in the next column to the right, e.g. labels from Column A become aliases for the cells in Column B.
 * : This macro helps managing cells inside FreeCAD Spreadsheet workbench.
 * : This macro save the data in a csv file with the formula or in a xml file.
 * : Exports a spreadsheet as styled html. Intended as support in transfering data to office suits.
 * [[Image:Text-x-python.png|24px]] sheet2export: allows to export FreeCAD spreadsheet to file formats (.md, .html, .csv, .json).

[[File:Arch_Survey.svg]] Utility

 * : This macro red trace (editable) the center face (mass) with 1 point and print the coordinates
 * : This macro covers the following constraints: - Concentric constraint among non cylindrical parts; - Constraint on center Faces and/or Edges. It works also with the new Body and App::Part containers, as well as with STEP hierarchy.
 * : This macro makes Cutouts for Enclosures in a very handy way
 * : Add the macros found in the macros folder to the Macros menu of FreeCAD
 * : Forces manual recompute of model
 * : measures time it takes to recompute each object in a project
 * : Shake a sketch in order to discover its unconstrained parts.
 * : Replaces a part (simple copy) in an "Assembly" with another Part (simple copy).
 * : This macro toggles the Drawstyle of the selected object
 * : This macro toggles the Drawstyle of the selected object (same Macro Toggle Drawstyle above optimized all language)
 * : Highlight common parts.
 * : Compute the difference between two shapes.
 * : displays an interactively slidable cross-section.
 * : prints the SceneGraph.
 * : This macro red trace (editable) around the BoundingBox with 6 rectangles
 * : This macro help you to create an Arch Axis System along a line with a
 * : This macro positioned your object perpendicularly to wire selected.
 * : Merges materials that have the same base name (with different numeral endings like 001, 002,...) into one.
 * : rebinds standard view commands from digit keys to Ctrl+digit, so that they don't spin the view by accident when entering numbers.
 * : finds user config files system.cfg and user.cfg, copies folder location to system clipboard, instructs user on renaming these files in order to reset FreeCAD settings, and opens folder with default file browser.
 * : Easily post screenshots to the FreeCAD forum.
 * : Ping users on the forum with ease.
 * : unmap a sketch from its current support and makes its placement absolute, eventually creating a locating datum plane.
 * : reset Part containers to global origin while maintaining objects absolute position.
 * : temporarily split the property editor from the combo view to a separated dock widget
 * : re-align object(s) with FreeCAD coordinate system according reference face/edge
 * : manage visibility of document objects by type or individually
 * : Prints model tree as "ASCII art" with custom pattern & style, and export to clipboard, file or embedded document
 * : Macro for list all objects in the project in one list without hierarchy, options sort by name, label, visibility, group, by length option search by name, label .... without case sensitive or with case sensitive and select all objects displayed in the macro window.
 * : Shows a list of US Imperial Arch scales list with the corresponding factor to apply to TechDraw pages or views

[[File:Bulb.svg]] Wizards

 * : Creates an unfolded part from a sheet-metal-part.
 * : allows to unroll ruled surfaces and to draw them on a page.
 * : allows to unfold the surfaces of a box of any shape and to draw them on a page.
 * : Imports and scales a .dat airfoil to desired chord length.
 * : Allows the user to create a Geneva wheel mechanism from scratch. Must edit values within the Macro to alter the size of the object.
 * : A GUI front end that allows the user to create a Geneva wheel mechanism from scratch.
 * : Creates a half turn (left/right) stair from a Data-file.
 * : This macro generates both three dimensional half-hull and full-hull models from a series of 2D line drawings.
 * : Create stair helix, create your stair nosing select and run the macro.
 * : Additional Workbench to create different types of gears, involute gear, involute rack, cycloide gear, bevel gear.
 * : pops up a dialog asking for the dimensions of your corner piece, then creates the object in the document and creates a page view with top, front and lateral views of the piece
 * : pops up a dialog asking for the dimensions of your corner piece, then creates the object in the document and creates a page view with top, front and lateral views of the piece
 * : This little macro create one Property additional (memo or other text) for you object (only Draft)
 * : This little macro is dedicate to users of Windows 10. The explorer fonts for use the ShapeString is empty and this little macro can help you see aesily the font to use.
 * : Display a Rubik Cube and interactively do slice rotations.
 * : Display a Megaminx and interactively do slice rotations.
 * : Airfoil coordinates import, then scale the airfoil, rotate, translate in the plane, translate along the span, select the plane and the main axis, and turn the geometry into a sketch.
 * : Macro for automatic 2D views generation with 6 normal projections and one isometric.
 * : Macro for automatic drawing generation with 3 normal projections and one isometric.

Std_FreeCADWebsite.svg Woodworking

 * : Creates side and top/bottom walls for a cabinet with drilled holes for connection parts of manufacturer Hettich.
 * : Creates a variety of joints, such as mortise/tenon, box joints, dovetail joints, and snap joints.
 * [[Image:Text-x-python.png|24px]] getDimensions: FreeCAD macro to get chipboards dimensions to cut (BOM, cutlist).

Std_FreeCADWebsite.svg Other interesting macros created by FreeCAD users

 * [[Image:2364.png|24px]] By microelly2 : freeCAD_macro, geodata, Animation, freecad-nurbs, PieMenu, and more.
 * [[Image:Text-x-python.png|24px]] By hamish2014: FreeCAD_assembly2, FreeCAD_drawing_dimensioning, and more.
 * [[Image:Text-x-python.png|24px]] By triplus: IconThemes, ShortCuts, NavigationIndicator, TabBar, Launcher, PersistentToolbars, PieMenu, and more.
 * [[Image:681.jpg|24px]] By rockn: FreeCAD-Timber, FreeCAD-addons, FreeCAD-library, FreeCAD-StructuresBois, and more.
 * [[Image:Text-x-python.png|24px]] By oddtopus: flamingo (workbench for metal structures).
 * [[Image:Text-x-python.png|24px]] By Siardeni: workbench for create metal profiles, square tubing, z profile, palette, rotation, drawing, and more.
 * [[Image:Text-x-python.png|24px]] By realthunder: Assembly3 workbench, and more.

Usage
See how to install macros for a full description, and customize toolbars to add the macros to a toolbar for easy access.

Installing many macros is equivalent to installing a new workbench; see how to install additional workbenches for this information.

Automatic installation
Use the Addon Manager in to install a macro that has been included in the FreeCAD-macros repository.

Manual installation
If the Addon Manager is not used, the macro can be installed manually.
 * Copy the Python code from the corresponding macro page.
 * Open the macros menu, press , and give it a name.
 * Paste the Python code that you copied.
 * Press the button, and restart FreeCAD.
 * To use it, open again the macros menu, select your new macro, and press.

Add a macro to a custom toolbar

 * Go to.
 * In the tab, add a new macro name, and optionally define an icon and a keyboard shortcut.
 * In the tab, create a new toolbar, and add your macro, taking it from the  category.