BIM Workbench

From FreeCAD Documentation

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Introduction

The BIM workbench is an external workbench aimed at implementing complete Building Information Modeling (BIM) tools and workflow in FreeCAD. It is an extension and currently looks much like the built-in Arch Workbench. The general idea, however, is to work as a "meta workbench", and gather in one place different tools from other workbenches that are useful to BIM, and create a workflow that is more convenient, easy and user-friendly to both experienced BIM users coming from other software like Revit or ArchiCAD and newcomers alike. The BIM workbench also features a couple of tools on its own, that are mostly wizards and management tools, located under the Management menu

Installing

The BIM workbench is not bundled with the default FreeCAD package, but can easily be installed via menu Tools -> Addons Manager. The BIM workbench code is hosted on github and can also be installed manually by copying it into FreeCAD's MOD directory. The BIM workbench is a work in progress, and will change often. Be sure to update it regularly!

Getting started

Upon starting the BIM workbench for the first time, a welcome dialog is shown, giving a quick overview of how the workbench works, and allowing the user to start an in-game tutorial. The welcome dialog is also available in the help menu. When the welcome screen is closed, the BIM setup dialog will be shown, that allows the user to quickly set some of the most common BIM-related preferences of FreeCAD without the need to browse through the full FreeCAD preferences pages.

The BIM project setup tool allows you to quickly setup a BIM project by filling some basic information about your project. You can then, for example, use the different 2D drafting tools to sketch guidelines and baselines, then use the different 3D modeling tools to build 3D BIM objects on top of it.

Tools

The BIM workbench gather tools from several other FreeCAD workbenches, mainly Draft, Arch and Part, roughly reorganized in three categories: 2D drafting tools, 3D modeling tools, annotation and modification tools. Additionally, if such addons are installed, tools from Reinforcement (extra reinforcing bar tools), Fasteners (bolts and screws) and Flamingo (metal structure and piping tools).

The BIM workbench also adds a couple 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.

2D drafting

  • Line: Draws a line segment between 2 points
  • Wire: Draws a line made of multiple line segments (polyline)
  • Circle: Draws a circle from center and radius
  • Arc: Draws an arc segment from center, radius, start angle and end angle
  • Ellipse: Draws an ellipse from two corner points
  • Polygon: Draws a regular polygon from a center and a radius
  • Rectangle: Draws a rectangle from 2 opposite points
  • BSpline: Draws a B-Spline from a series of points
  • Bezier Curve: Draws a Bezier curve from a series of points
  • Point: Inserts a point object

Annotation

  • Text: Draws a multi-line text annotation
  • ShapeString: The ShapeString tool inserts a compound shape representing a text string at a given point in the current document
  • Dimension: Draws a dimension annotation
  • Label: Places a label with an arrow pointing to a selected element introduced in version 0.17
  • Axis tools
    • Axis: Adds a 1-direction array of axes to the document
    • Axes system: Adds an axes system composed of several axes to the document
    • Grid: Adds a grid-like object to the document
  • Section Plane: Adds a section plane object to the document

3D / BIM modeling

  • Building Part: Creates a building part including selected objects. Building parts are commonly used to represent levels
  • Building: Creates a building including selected objects
  • Site: Creates a site including selected objects
  • Wall: Creates a wall from scratch or using a selected object as a base
  • Structural element: Creates a structural element from scratch or using a selected object as a base
  • Rebar tools
    • Straight Rebar: Creates a Straight reinforcement bar in a selected structural element
    • UShape Rebar: Creates a UShape reinforcement bar in a selected structural element
    • LShape Rebar: Creates a LShape reinforcement bar in a selected structural element
    • Bent Shape Rebar: Creates a Bent Shape reinforcement bar in a selected structural element
    • Stirrup Rebar: Creates a Stirrup reinforcement bar in a selected structural element
    • Helical Rebar: Creates a Helical reinforcement bar in a selected structural element
    • Rebar: Creates a custom reinforcement bar in a selected structural element using a sketch
  • Window: Creates a window using a selected object as a base
  • Pipe tools
    • Pipe: Creates a pipe
    • Pipe Connector: Creates a corner or tee connection between 2 or 3 selected pipes
  • Stairs: Creates a stairs object in the document
  • Roof: Creates a sloped roof from a selected 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: Allow to nest several flat objects inside a container shape
  • Equipment: Creates an equipment or furniture object
  • Frame: Creates a frame object from a selected layout
  • Box: Draws a box by specifying its dimensions
  • Shapebuilder: A tool to create more complex shapes from various parametric geometric primitives
  • Facebinder: Creates a new object from selected faces on existing objects
  • Space: Creates a space object in the document

Modification tools

  • Move: Moves object(s) from one location to another
  • Copy: Copies object(s) from one location to another
  • Rotate: Rotates object(s) from a start angle to an end angle
  • Clone: Clones the selected objects
  • Offset: Moves segments of an object about a certain distance
  • 2D Offset: Constructs a parallel wire at certain distance from original, or enlarges/shrinks a planar face ((parametric version)
  • Trim/Extend (Trimex): Trims or extends an object
  • Scale: Scales selected object(s) around a base point
  • Stretch: Stretches the selected objects
  • Array: Creates a polar or rectangular array from selected objects
  • Path Array: Creates an array of objects by placing the copies along a path
  • Mirror: Mirrors the selected objects
  • Extrude: Extrudes planar faces of an object
  • Cut: Cuts (subtracts) one object from another
  • Union: Fuses (unions) two objects
  • Common: Extracts the common (intersection) part of two objects
  • Compound: Creates a compound from the selected objects
  • File:Part MakeSimpleCopy.png Simple copy: Creates a non-parametric copy of a selected object
  • Upgrade: Joins objects into a higher-level object
  • Downgrade: Explodes objects into lower-level objects
  • Shape 2D View: Creates a 2D object which is a flattened 2D view of another 3D object
  • Draft to Sketch: Converts a Draft object to Sketch and vice-versa
  • Cut with plane: Cut an object according to a plan.
  • Add component: Adds objects to a component
  • Remove component: Subtracts or removes objects from a component

Management tools