Macros recipes

From FreeCAD Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎română • ‎русский • ‎svenska
Text-x-python.png Macros

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.

Categories

Part CheckGeometry.svg 3D View operations

  • Text-x-python.png Macro Rotate View: This macro rotates the current view by 90° to the left. Only works if you are in Top view.
  • Text-x-python.png Macro View Rotation: Provides a GUI to permit rotation of view by precise amounts in all three directions.
  • Text-x-python.png Macro Texture Objects: This macro allows you to temporarily put a texture image on the selected objects.
  • Text-x-python.png Macro Mouse Cross: This small macro turns the arrow of the mouse in a precision cross.
  • Text-x-python.png Macro Align View to Face: This macro aligns the current view to a selected face.
  • Text-x-python.png Macro Align Object to View: This macro align the selected object to the current View and set the coordinates Placement of the camera.
  • Text-x-python.png Macro Align Camera to Working Plane: This macro aligns the camera to the current Draft Working Plane
  • Text-x-python.png Macro Align Working Plane to Camera: This macro moves the current Draft Working Plane to the center of the current view
  • Text-x-python.png Macro Align Face Object to 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).
  • Macro Toggle Views Visibility.png Macro Toggle Panels Visibility: This macro toggles the visibility of various supporting panels in FreeCAD, allowing the main window to be viewed with all available screen space.
  • FCCamera 00.png Macro FCCamera: 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.
  • Macro SelectVisible.png Macro Toggle Visibility: Set of three macro, macro 1: hidden the objects not selected, macro 2: displayed alls objects, macro 3: hidden alls objects.
  • Macro SelectVisible2.png Macro Toggle Visibility2: Set of two macro, macro 1: hidden the objects not selected, macro 2: displayed alls objects, macro with the original visibility.
  • SelectVisible.png Macro SelectVisible: All visible objects in the tree will be selected.
  • Text-x-python.png Macro Manage Navigational Style: This pair of macros allow you to alter the Navigation Style while in the Sketcher.
  • Text-x-python.png Macro Duplicate Selection: 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.
  • Macro Copy3DViewToClipboard.png Macro Copy3DViewToClipboard: Copy contents of 3DView resized 640, 480 px to clipboard .
  • Macro Perpendicular To Wire.png Macro Perpendicular To Wire: This macro positioned your object perpendicularly to wire selected.
  • Macro Rotate To Point.png Macro Rotate To Point: Macro for rotate on object on itself with the axis of rotation the boundbox center, center of mass or last point clicked
  • Macro FCTreeView.png Macro FCTreeView: 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.
  • Macro Select Hovering.png Macro Select Hovering: this macro select a choice Face, Edge, Vertex hovering by the mouse.
  • Macro ExpandTreeItem.png Macro ExpandTreeItem: this macro expand selected items in the tree view.. If not selection all item are expand/collapse
  • Text-x-python.png Macro Mouse over cb: this macro display all elements below cursor (elements covered by other elements will also be displayed)
  • Text-x-python.png Macro FC element selector: this macro display all elements below cursor same "Macro Mouse over cb" with GUI (elements covered by other elements will also be displayed)

Draft FlipDimension.svg Animation

Applications-python.svg Code and Scripting

  • Text-x-python.png Macro MessageBox: shows how to give information to the user through the GUI.
  • MEPlan.png Qt Example: example of using Qt commands, their connections, extraction and data assignment.
  • Macro Python Assistant Window.png Macro Python Assistant Window: 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.
  • Macro Build Utility.png Macro Build Utility: This macro provides a utility to assemble a project from sub-project files using the Merge Project facility.
  • Macro Global Variable Watcher.png Macro Global Variable Watcher: This macro facilitates the user selecting global variables and monitoring their values.

Arch MeshToShape.svg Conversion

Drawing-orthoviews.svg Drawing Workbench

The Drawing Workbench is considered obsolete since FreeCAD 0.17. Consider using the TechDraw Workbench instead.

  • Text-x-python.png Macro Automatic drawing: 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
  • Text-x-python.png Macro CartoucheFC: 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.
  • Macro CartoucheFC Full.png Macro CartoucheFC Full: 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.
  • Text-x-python.png Macro CartoucheFC 2: This GUI macro to fill simply all fields of the cartridge model 2 of the plan implementation worksheet FreeCAD.
  • Text-x-python.png Macro Normal Vector: Get the normal vector of a preselected face for creating a drawing view normal to that face

Draft BSpline.svg Dxf 2D Draft

Fem ResultDisplacement.svg Fem

  • Text-x-python.png Macro GMSH: Create FEM Meshes by GMSH Mesh Generator

Part Measure Clear All.svg Info and measures

  • FCInfo.png Macro FCInfo: 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
  • FCInfo.png Macro FCInfo Alternate Linux: same as above, but for Linux
  • Macro FCInfoGlass.png Macro FCInfoGlass: Gives a series of information about the selected shape and displayed in screen 3D
  • FCInfoToMouse.png Macro FCInfoToMouse: Provide informations coordinates, length and angles in real time on the mouse in a bubble annotation displayed in the 3D screen
  • Text-x-python.png Macro Delta xyz: Gives the Delta values and the distance between 2 points
  • Text-x-python.png Macro ObjectInfo: User-friendly "Info" module created by a FreeCAD user
  • Macro Dump Objects.png Macro Dump Objects: This macro generates a listing of all objects in the current document - the list can be in a window or on the Report view.
  • Macro MeasureCircle.png Macro MeasureCircle: Compute the radius of a circle by 3 points or a circular edge.
  • Macro CenterOfMass.png Macro CenterOfMass: Gives the total mass and the center of mass of multiple objects selected with the density chosen.

Draft VisGroup.svg Libraries

Bound-expression.svg Mathematical functions

equations.

IFC.svg Multifunctional

  • WF wf.png Macro WorkFeatures: 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.

Workbench Image.svg Object creation

  • Macro makeCube.png Macro Make Cube: creates a rectangular cuboid from 4 points
  • Text-x-python.png Macro Solid Sweep: 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.
  • Text-x-python.png Macro Geodesic Dome: This macro creates a geodesic dome shell
  • Text-x-python.png Macro Line Length: Create a line giving coordinate XYZ length and angle to plane X Y
  • Text-x-python.png Macro Cut Line: 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.
  • Macro CirclePlus.png Macro CirclePlus: 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.
  • Text-x-python.png Macro Circle: Create a circle or arc giving radius, diameter, circumference, area, startangle, endangle, arc, anglecenter, cord, arrow, center (point) on choice (same above without GUI).
  • Text-x-python.png Macro Cut Circle: Cut a circle or arc and create x arcs, giving the number of cut.
  • Text-x-python.png Macro Triangle AH: 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)
  • FCTexture.png Macro Texture: Create a project from a bmp image to create a texture easily
  • FCCreaLoft.png Macro Loft: Create a loft with a list of wire (specially created for Macro Texture see above)
  • FCCircularTextButtom.png Macro Circular Text: This macro create a text around a cylinder
  • Text-x-python.png Macro WireXYZ: This macro creates a Wire with the coordinates extracted from a file. The coordinates X Y Z are separated by a space.
  • Macro ReproWire.png Macro Repro Wire: This macro reproduce all element selected subobject wire or face.
  • Part Prism Apothem.svg Macro Apothem Based Prism GUI: A GUI dialog that creates an Apothem, (inradius) Based Prism from user input.
  • FCSpring Helix Variable.png Macro FCSpring Helix Variable: This macro create one spring truncate, the troncature is adjustable on the all coil to choice.
  • Text-x-python.png Macro Guitar fretboard: Guitar Fretboard Maker
  • Cam-groover-icon-32x32.png Macro FCCamGroover: Creates grooved cylinder for cam.
  • Text-x-python.png Macro Site From Contours: creates an Arch Site from a series of contour lines

Workbench PartDesign.svg Object transformation

  • Text-x-python.png Macro ArrayCopy: copies the selected object several times, on an array grid
  • Text-x-python.png Macro FlattenWire: flattens draft wires that are not planar to their median Z coordinate
  • Text-x-python.png Macro FlattenWire3Points: flattens draft wires that are not planar to a plane defined by 3 points
  • Text-x-python.png Macro JointWire: allows to find and joint all non connected edge to the closest non connected one using a line
  • Text-x-python.png Macro Remove parametric history: removes all parametric associativity from an object, leaving it as a "dumb" shape
  • Text-x-python.png Macro SuperWire: Forces the creation of a Wire from lines and arcs that don't necessarily touch each other. Use this if normal wire operation fails
  • Text-x-python.png Macro HealArcs: 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
  • Macro CloneConvert.png Macro CloneConvert: 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)
  • Text-x-python.png Macro Image Scaling: Macro for easy scaling drawings, graphics, diagram, blueprint and similar 2D images in Image workbench.
  • Text-x-python.png Macro MatrixTransform: apply linear space transformations to distort shapes. E.g., non-uniform scaling, shearing, mirroring, axes swapping.
  • Macro Connect And Sweep.png Macro Connect And Sweep: This macro easily creates a connection between two objects, an object and a point or between two points (the center of the objects are the starting and ending points of the sweep) can be selected form a configurable ellipse polygon circle
  • Part Section.png Macro Section: (parametric): alternative implementation of Part Section tool, more suitable for making sweep paths.
  • Macro Overlap.png Macro Overlap: (parametric): Boolean operation. Similar to Part Common, but with custom overlap count threshold.

View.svg Printer 3D

Preferences-raytracing.svg Raytracing

Spreadsheet.svg Spreadsheet Workbench

  • Aliasmanager icon.png Macro Alias Manager: helps managing aliases inside FreeCAD Spreadsheet workbench. It is able to create, delete, move aliases and create a 'part family' group of files.
  • Text-x-python.png Macro Spreadsheet Tools: This macro helps managing cells inside FreeCAD Spreadsheet workbench.
  • Macro FCTreeView.png Macro FCTreeView: 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.
  • Macro FCSpreadsheet Extract.png Macro FCSpreadSheet Extract: This macro save the data in a csv file with the formula or in a xml file.

Arch Survey.svg Utility

Bulb.svg Wizards

  • Text-x-python.png Macro Sheet Metal Unfolder: Creates an unfolded part from a sheet-metal-part.
  • Text-x-python.png Macro Unroll Ruled Surface: allows to unroll ruled surfaces and to draw them on a page.
  • Text-x-python.png Macro Unfold Box: allows to unfold the surfaces of a box of any shape and to draw them on a page.
  • Text-x-python.png Macro Airfoil Import & Scale: Imports and scales a .dat airfoil to desired chord length.
  • GW Dim.png Macro Geneva Wheel: Allows the user to create a Geneva wheel mechanism from scratch. Must edit values within the Macro to alter the size of the object.
  • GW Dim.png Macro Geneva Wheel GUI: A GUI front end that allows the user to create a Geneva wheel mechanism from scratch.
  • Cabinets32.png Macro Cabinets32: creates side and top/bottom walls for a cabinet with drilled holes for connection parts of manufacturer Hettich.
  • Text-x-python.png Macro Half_turn_stairs: Creates a half turn (left/right) stair from a Data-file.
  • Macro Half Hull Model.png Macro Half-Hull Model: This macro generates both three dimensional half-hull and full-hull models from a series of 2D line drawings.
  • Text-x-python.png Macro Stairs: Create stair helix, create your stair nosing select and run the macro.
  • Gearworkbech.png Macro FCGear: Additional Workbench to create different types of gears, involute gear, involute rack, cycloide gear, bevel gear.
  • Text-x-python.png Macro Corner shapes wizard: 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
  • PropertyMemo.png Macro PropertyMemo: This little macro create one Property additional (memo or other text) for you object (only Draft)

Std FreeCADWebsite.png Other interesting macros created by FreeCAD users

  • 2364.png By microelly2 : freeCAD_macro, geodata, Animation, freecad-nurbs, PieMenu, and more.
  • Text-x-python.png By hamish2014: FreeCAD_assembly2, FreeCAD_drawing_dimensioning, and more.
  • Text-x-python.png By triplus: IconThemes, ShortCuts, NavigationIndicator, TabBar, Launcher, PersistentToolbars, PieMenu, and more.
  • 681.jpg By rockn: FreeCAD-Timber, FreeCAD-addons, FreeCAD-library, FreeCAD-StructuresBois, and more.
  • Text-x-python.png By oddtopus: flamingo (workbench for metal structures).
  • Text-x-python.png By dprojects: getDimensions FreeCAD macro to get chipboards dimensions to cut (woodworking).
  • Text-x-python.png By Siardeni: workbench for create metal profiles, square tubing, z profile, palette, rotation, drawing, and more.
  • Text-x-python.png By realthunder: Assembly3 workbench, and more.


How to use

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

Starting with FreeCAD 0.17, use the Addon Manager in Tools → Addon manager 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 Macro → Macros, press Create, and give it a name.
  • Paste the Python code that you copied.
  • Press the Save button, and restart FreeCAD.
  • To use it, open again the macros menu, select your new macro, and press Execute.

Add a macro to a custom toolbar

  • Go to Tools → Customize.
  • In the Macros tab, add a new macro name, and optionally define an icon and a keyboard shortcut.
  • In the Toolbars tab, create a new toolbar, and add your macro, taking it from the Macros category.