BIM Workbench/cs

The BIM workbench gathers tools from several other FreeCAD workbenches, mainly Draft and Part, roughly reorganized in logical categories.

Additionally, if such addons are installed, tools from Reinforcement (extra reinforcing bar tools), Fasteners (bolts and screws), Flamingo/Dodo (metal structure and piping tools) and Parts Library are automatically included in the BIM workbench.

The BIM workbench also adds a series of items in the Status Bar of FreeCAD, and a couple of context menu items, accessible by right-clicking in the 3D View or in the Tree View.

The order of the tools matches the version 26.3 menu.

2D Drafting

2D objects are commonly used as drafting aids, or to draw base lines and profiles to build BIM objects on. They can also be used to draw symbols and annotations in your model. Apart from sketches, that use their own coordinate system, 2D objects will be drawn on the current working plane.

• Sketch: Creates a new sketch and enters sketch edit mode. Sketches are advanced 2D objects with constraints support.

• Line: Creates a straight line.

• Polyline: Creates a polyline (also called wire), a sequence of several connected line segments.

• Rectangle: Creates a rectangle from two points.

• Arc Tools:

• Arc: Creates a circular arc from a center, a radius, a start angle and an aperture angle.

• Arc From 3 Points: Creates a circular arc from three points that define its circumference.

• Circle: Creates a circle from a center and a radius.

• Ellipse: Creates an ellipse from two points defining a rectangle in which the ellipse will fit.

• Polygon: Creates a regular polygon from a center and a radius.

• Spline Tools:

• B-Spline: Creates a B-spline curve from several points.

• Bézier Curve: Creates a Bézier curve from several points.

• Cubic Bézier Curve: Creates a Bézier curve of the third degree.

• Point: Creates a simple point.

• Fillet: Creates a fillet, a rounded corner, or a chamfer, a straight edge, between two Draft Lines.

3D and BIM objects are the real-world elements that will compose your BIM project.

• Site: Creates a site including selected objects.

• Building: Creates a building including selected objects.

• Level: Creates a floor including selected objects.

• Space: Creates a space object.

• Wall: Creates a wall from scratch or using a selected object as a base.

• Curtain Wall: Creates a curtain wall from scratch or using a selected object as a base.

• Column: Creates a vertical structural element at a given point, optionally using a selected object as a profile.

• Beam: Creates a horizontal structural element between two points, optionally using a selected object as a profile.

• Slab: Creates a flat structural element by extruding a selected flat object.

• Door: Creates a Window object using door presets.

• Window: Creates a window from scratch or using a selected object as a base.

• Covering: Creates a surface finish applied to a planar face. introduced in 26.3

• Pipe: Creates a pipe.

• Connector: Creates a corner or T-connection between 2 or 3 selected pipes.

• Stairs: Creates a stairs object.

• Roof: Creates a sloped roof from a selected wire.

• Panel: Creates a panel object from a selected 2D object.

• Frame: Creates a frame object from a selected layout.

• Fence: Creates a fence object from a selected post and path.

• Truss: Creates a truss from a selected line or from scratch.

• Equipment: Creates an equipment or furniture object.

• Reinforcement Tools:

These tools, except the first, are only available if the Reinforcement Workbench has been installed.

• Custom Rebar: Creates a custom reinforcement bar in a selected structural element using a sketch.

• Straight Rebar: Creates a straight reinforcement bar in a selected structural element.

• U-Shape Rebar: Creates a U-shape reinforcement bar in a selected structural element.

• L-Shape Rebar: Creates an L-shape reinforcement bar in a selected structural element.

• Stirrup: Creates a stirrup reinforcement bar in a selected structural element.

• Bent-Shape Rebar: Creates a bent-shape reinforcement bar in a selected structural element.

• Helical Rebar: Creates a helical reinforcement bar in a selected structural element.

• Column Reinforcement: Creates reinforcement bars in a selected column.

• Beam Reinforcement: Creates reinforcement bars in a selected beam.

• Slab Reinforcement: Creates reinforcement bars in a selected slab.

• Footing Reinforcement: Creates reinforcement bars in a selected footing.

• Generic 3D Tools:

These tools build generic 3D objects that can be turned or used into BIM components.

• Profile: Creates a parametric 2D profile.

• Box: Creates a box by specifying its dimensions graphically.

• Shape Builder: Creates more complex shapes from various geometric primitives.

• Facebinder: creates a surface object from selected faces.

• Objects Library: Inserts an equipment or furniture object. Requires the Parts Library addon.

• Component: Creates a non-parametric Arch component.

• External Reference: Links objects from another FreeCAD file into the current document.

Annotation

Annotations are visual help objects that can be placed inside your model. They can be used to export your model directly to a 2D format like DXF, or reused when creating 2D views of your model with the TechDraw Workbench.

• Aligned Dimension: Creates a dimension aligned with two points or a selected edge.

• Horizontal Dimension: Creates an horizontal dimension between two points or from a selected edge.

• Vertical Dimension: Creates a vertical dimension between two points or from a selected edge.

• Text: Creates a 2D text in a document or on a TechDraw page.

• Leader: Creates a 2-segment polyline with an arrow at its end, to be used as a leader line in conjunction with a Text.

• Label: Creates a multi-line text with a 2-segment leader line and an arrow.

• Hatch: Creates hatches on the planar faces of a selected object.

• Axis Tools:

• Axis: Adds a 1-direction array of axes.

• Axis System: Adds an axis system composed of several axes.

• Grid: Adds a grid-like object.

• Section Plane: Adds a section plane object.

• Create 2D Views:

• 2D Drawing: Creates a container to hold 2D projections.

• Section View: Creates a 2D projected view from a selected object such as a Section plane or a Level.

• Section Cut: Creates a 2D cut view from a selected object such as a Section plane or a Level.

• New Page: Creates a TechDraw page from a template SVG file.

• New View: Creates a view of the selected object(s) such as a Section plane or a Group containing the different elements of a 2D view.

Snapping

This menu contains the Draft Snap tools as well as the following tools:

• Working Plane Front: Places the working plane on the global XZ-plane (front).

• Working Plane Top: Places the working plane on the global XY-plane (ground).

• Working Plane Side: Places the working plane on the global YZ-plane (side).

• Working Plane: Defines the current working plane.

Modify

• Move: Moves or copies selected objects from one point to another.

• Rotate: Rotates or copies selected objects around a center point by a given angle.

• Scale: Scales or copies selected objects around a base point.

• Mirror: Creates mirrored copies from selected objects.

• Cloning Tools:

• Clone: Clones and moves selected objects.

• Make Link: Links and moves selected objects. introduced in 26.3

• Copy: Copies selected objects from one point to another.

• Simple Copy: Creates a non-parametric copy of a selected object. This is the same tool as Part SimpleCopy.

• Compound: Creates a compound from selected objects. This is the same tool as Part Compound.

• Offset Tools:

• 2D Offset: Constructs a parallel wire at a given distance from the original, or enlarges/shrinks a planar face (parametric version). This is the same tool as Part Offset2D.

• Offset: Offsets each segment of a selected object over a given distance, or creates an offset copy of the selected object.

• Trimex: Trims or extends a selected object.

• Join: Joins Draft Lines and Draft Wires into a single wire.

• Split: Splits a Draft Line or Draft Wire at a specified point or edge.

• Stretch: Stretches objects by moving selected points.

• Draft to Sketch: Converts Draft objects to Sketcher Sketches and vice versa.

• Upgrade: Upgrades selected objects.

• Downgrade: Downgrades selected objects.

• Add Component: Adds objects to a component.

• Remove Component: Subtracts or removes objects from a component.

• Array Tools:

• Array: Creates an orthogonal array from a selected object. It can optionally create a Link array.

• Path Array: Creates an array from a selected object by placing copies along a path.

• Polar Array: Creates an array from a selected object by placing copies along a circumference. It can optionally create a Link array.

• Point Array: Creates an array from a selected object by placing copies at the points from a point compound.

• Cut With Plane: Cuts an object according to a plane.

• Extrude: Extrudes planar faces of an object. This is the same tool as Part Extrude.

• Boolean Tools:

• Union: Fuses two objects. This is the same tool as Part Fuse.

• Difference: Subtracts one object from another. This is the same tool as Part Cut.

• Intersection: Extracts the common part of two objects. This is the same tool as Part Common.

Manage

• BIM Setup: Configures some of the FreeCAD preferences most commonly used for BIM.

• Setup Project: Allows to create some basic objects such as a site, a building and axes by filling basic project information.

• Manage Doors and Windows: Manage the doors and windows of your project.

• IFC Management:

• Manage IFC Elements: Manage how the different elements of your project will be exported to IFC.

• Manage IFC Quantities: Manage how the quantities of your objects are explicitely exported to IFC

• Manage IFC Properties: Manage the IFC properties attached to each of your objects.

• Manage Classification: Manage how objects and materials of your project relate to classifications systems such as Uniclass.

• Manage Layers: Manage the layers of your document.

• Material: Manages materials or multimaterials of selected objects

• Report Tools:

• BIM Report: Creates a new BIM Report to query model data with SQL. introduced in 26.3

• Schedule: Creates different types of schedules.

• Preflight Checks: Perform different checks on your model before exporting to IFC.

• Annotation Styles: Allows you to define styles that affect the visual properties of annotation-like objects.

Utils

• Move to Trash: Moves selected objects to a Trash group, which gets created if necessary

• Working Plane View: Sets the camera to face the current working plane

• Select Group: Selects the contents of Std Groups or group-like Arch objects.

• Set Slope: Slopes selected Draft Lines or Draft Wires by increasing, or decreasing, the Z-coordinate of all points after the first one.

• Working Plane Proxy: Creates a working plane proxy to save the current Draft working plane.

• Add to Construction Group: Moves objects to the Draft construction group.

• Split Mesh: Splits a selected mesh into separate components.

• Mesh to Shape: Converts a mesh into a shape, unifying coplanar faces.

• Select Non-Manifold Meshes: Selects all non-manifold meshes from the current selection or from the document.

• Remove Shape From BIM: Turns cubic shape-based Arch object fully parametric.

• Close Holes: Closes holes in a selected shape-based object.

• Merge Walls: Merges walls.

• Check: Check if the selected objects are solids and don't contain defects.

• Toggle IFC B-Rep Flag: Forces a selected object to be exported as an IfcFacetedBrep.

• Toggle Subcomponents: Shows or hides the subcomponents of an Arch object.

• Survey: Enters or leaves surveying mode.

• IFC Shape Diff: Shows a visual diff between two IFC files

• IFC Explorer: Opens a tool to explore the structure of an IFC file prior to importing

• New IFC Spreadsheet: This tool creates a spreadsheet to store IFC properties of an object.

• Image Plane: Inserts an image plane in the document.

• Unclone: Makes a cloned object independent from its original object

• Rewire: Recreates wires from the edges of selected objects.

• Glue: Joins selected shapes into one non-parametric compound shape.

• Re-Extrude: Recreates an extrusion from a shape that has lost its parametric extrusion by selecting a base face

• Panel Tools:

• Panel: Creates a panel object from a selected 2D object.

• Panel Cut: Creates a 2D cut view from a panel.

• Panel Sheet: Creates a 2D cut sheet including panel cuts or other 2D objects.

• Nest: Allows to nest several flat objects inside a container shape.

• Structure Tools:

• Structure: Creates a structural element from scratch or using a selected object as a base.

• Structural System: Creates a structural system by distributing a structure along axis systems.

• Multiple Structures: Creates multiple structure elements from a base object, using selected edges as extrusion paths.

• IFC Project: Creates an IFC project including selected objects.

• IFC File Diff: Shows the current unsaved changes in the IFC file.

• IFC Expand: Expands the children of the selected objects or of the document.

• Convert to IFC Project: Converts the selected objects into an IFC project structure.

• IfcOpenShell Update: Updates the embedded IfcOpenShell libraries used by the NativeIFC tools.

• Nudge:

A set of tools that incrementally move, rotate, or change the height of selected objects.

• Nudge Switch

• Nudge Up

• Nudge Down

• Nudge Left

• Nudge Right

• Nudge Rotate Left

• Nudge Rotate Right

• Nudge Extend

• Nudge Shrink

Status Bar

The Status Bar contains a few buttons that allow to easily change different states:

• Toggle BIM views panels on/off: Shows or hides the BIM Views panel.

• Toggle 3D View background between simple and gradient: Cycles between vertical gradient, radial gradient and simple color background modes. This can be used to toggle between a dark background for modelling and a white background for 2D drawing.

• Lock IFC: Switches strict IFC mode on/off.

Tree View context menu

TBD

3D View context menu

TBD

Obsolete tools

• Arch 3Views: Creates top, front and side views from a mesh. Not available in 1.0 and above.

• Arch BuildingPart: Creates a building part including selected objects. Not available in 1.0 and above. Use Arch Floor instead.

• Arch CloneComponent: Produces Arch Components that are clones of selected Arch objects. Not available in 1.0 and above. Use Draft Clone instead.

• Arch CutLine: Cuts an object according to a line. Not available in 1.0 and above. Use Arch CutPlane instead.

• Arch MultiMaterial: Creates a multi-material and attributes it to selected objects, if any. Not available in 1.0 and above. Use BIM Material instead.

• Arch Project: Creates a project including selected objects. Not available in 1.0 and above. Use BIM Project instead.

• Arch SetMaterial: Creates a material and attributes it to selected objects, if any. Not available in 1.0 and above. Use BIM Material instead.

• Toggle Bottom Panels: Shows or hides output windows (the Report View and the Python Console). Not available in 26.3 and above. Use Std ToggleBottomPanels instead.

Preferences

• Preferences: General preferences for the BIM Workbench.
• Fine tuning: Extra parameters to fine-tune BIM behavior.

Working with IFC

The BIM workbench works natively with Industry Foundation Classes (IFC) files. Native means there is no more translation between the IFC contents and FreeCAD: The IFC contents are directly rendered in FreeCAD, and any change affects the IFC contents directly. Read more on Native IFC.

Native IFC support requires IfcOpenShell. If it is not available, FreeCAD reports that IFC support is disabled and the other BIM tools remain available. Use the IfcOpenShell Update tool to install or update the dependency.

If you don't plan to work with others, and have no need for IFC, you can still use the BIM workbench tools and simply ignore anything related to IFC. You can still export your model to IFC anytime.

The old Arch IFC importer is disabled by default in FreeCAD, but still available from Python.

There is also a specific Native IFC Tutorial that explains the concepts further.

File formats

• IFC: industry foundation classes
• DAE: Collada mesh format
• OBJ: OBJ mesh format (export only)
• JSON: JavaScript Object Notation format (export only)
• 3DS: 3DS format (import only)
• SHP: GIS Shapefiles (import only)

API

The Arch module can be used in Python scripts and macros using the Arch Python API functions.

Tutorials and learning

• Migrating to FreeCAD from Revit
• Arch & BIM tutorials on this wiki
• "BIM with FreeCAD" video series by Yorik
• "FreeCAD tutorials" video series by Regis
• "Quinta Monroy" video series by Regis
• "HRCompacta" youtube channel (most content is in portuguese)
• "FreeCADBIM" youtube channel (most content is in portuguese)
• "FCB Lounge" youtube channel dedicated to BIM and Draft content

Example files

• FreeCAD features a BIM example file on the Start Page.
• More example BIM files are available at https://github.com/yorikvanhavre/FreeCAD-BIM-examples. From within FreeCAD, use menu Help → BIM Examples.
• OSArch Wiki (OpenSource Architecture) provides FreeCAD BIM examples created by multiple authors: https://wiki.osarch.org/index.php?title=FreeCAD/Architecture_3D_models_created_in_FreeCAD.