Difference between revisions of "Arch IFC"

From FreeCAD Documentation
Jump to navigation Jump to search
(Remove Installing section as the information is already described in IfcOpenShell.)
(Simplified the introduction)
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
<translate>
 
<translate>
 
<!--T:20-->
 
<!--T:20-->
{{docnav
+
{{Docnav
 
|
 
|
|[[Arch DAE|DAE]]
+
|[[Arch_DAE|DAE]]
 
|[[Arch_Module|Arch Module]]
 
|[[Arch_Module|Arch Module]]
 
}}
 
}}
Line 12: Line 12:
 
<translate>
 
<translate>
  
== Description ==
+
== Description == <!--T:49-->
  
 
<!--T:5-->
 
<!--T:5-->
The [[Arch_Workbench|Arch]] and [[BIM_Workbench|Build Information Modeling (BIM)]] workbenches feature an [http://en.wikipedia.org/wiki/Industry_Foundation_Classes Industry Foundation Classes (IFC)] importer and exporter. The IFC format is a continuously growing widespread format to interchange data between [http://en.wikipedia.org/wiki/Building_Information_Modeling BIM] applications, used in architecture and engineering.
+
The [[File:Workbench_Arch.svg|24px]] [[Arch_Workbench|Arch]] and [[File:Workbench_BIM.svg|24px]] [[BIM_Workbench|BIM Workbenches]] feature an [http://en.wikipedia.org/wiki/Industry_Foundation_Classes Industry Foundation Classes (IFC)] importer and exporter. The IFC format is a continuously growing format to interchange data among [http://en.wikipedia.org/wiki/Building_Information_Modeling BIM] applications, used in architecture and engineering.
  
 
<!--T:6-->
 
<!--T:6-->
Both the importer and exporter depend on an external piece of open-source software, called [[IfcOpenShell|IfcOpenShell]], which might or might not be bundled with your version of FreeCAD, depending on the platform and where you obtained your FreeCAD package from. If IfcOpenShell is correctly installed, it will be detected by FreeCAD and used to import and export IFC files. An easy way to check if IfcOpenShell is present and available, is either to try to import or export an IFC file, or simply enter the following in the [[Python_console|Python console]]:
+
Both the importer and exporter depend on the [[IfcOpenShell|IfcOpenShell]] library, which is bundled in some distributions of FreeCAD. An easy way to check if IfcOpenShell is available is to enter the following in the [[Python_console|Python console]]:
  
 
</translate>
 
</translate>
Line 27: Line 27:
  
 
<!--T:22-->
 
<!--T:22-->
If no error message appears, IfcOpenShell is correctly installed. Otherwise, you will need to install it yourself; read the  [[IfcOpenShell|IfcOpenShell]] page to learn more about this process.
+
If no error message appears, IfcOpenShell is installed, and you may proceed with [[Std_Import|importing]] IFC files. Otherwise, you will need to install IfcOpenShell yourself; read the  [[IfcOpenShell|IfcOpenShell]] page to learn more about this process.
  
 
<!--T:23-->
 
<!--T:23-->
'''Note''': the [[BIM_Setup|BIM Setup]] tool will look for IfcOpenShell too and issue a notification if it is not installed.
+
{{Emphasis|Note:}} the {{Button|[[File:BIM_Setup.svg|16px]] [[BIM_Setup|BIM Setup]]}} tool will look for IfcOpenShell too, and issue a notification if it is not installed.
  
 
<!--T:24-->
 
<!--T:24-->
'''Note''': in the past the Arch Workbench used to feature (2013) a simple IFC importer that didn't depend on IfcOpenShell. It is still included in the source code but as of v0.19 it is not recommended at all; it will only be able to import a very small subset of IFC objects, and should be considered completely discontinued.
+
{{Emphasis|Note 2:}} in the past (2013) the Arch Workbench used to feature a simpler IFC importer that didn't depend on IfcOpenShell. This legacy module is still included in the source code but as of v0.19 it is not recommended at all; it will only be able to import a very small subset of IFC objects, and should be considered completely obsolete.
  
 
==Importing== <!--T:4-->
 
==Importing== <!--T:4-->
  
 
<!--T:12-->
 
<!--T:12-->
All [http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifckernel/lexical/ifcproduct.htm IfcProduct]-based entities from IFC2x3 or IFC4 files will be imported into the FreeCAD document. The IFC preferences settings allow you to set how the IFC objects are imported: as '''full parametric Arch objects''' (the geometry will, as much as possible, be editable in FreeCAD), as '''non-parametric Arch objects''' (objects will carry IFC information and properties but will not be editable), as '''non-parametric Part shapes''' (the geometry will be faithfully rendered but IFC information will be discarded), or as '''one Part shape per floor''' (one all-in-one object, just for reference). Each of these types looses some information over the previous one, but is lighter on resources, which allows to open bigger files. A last type allows to discard entirely the importing of Arch objects, which is useful for structural analytic models.  
+
All [http://www.buildingsmart-tech.org/ifc/IFC4/Add1/html/schema/ifckernel/lexical/ifcproduct.htm IfcProduct]-based entities from IFC2x3 or IFC4 files will be imported into the FreeCAD document. The IFC preferences settings allow you to set how the IFC objects are imported:
 +
* '''full parametric Arch objects''', the geometry will, as much as possible, be editable in FreeCAD
 +
* '''non-parametric Arch objects''', objects will carry IFC information and properties but will not be editable
 +
* '''non-parametric Part shapes''', the geometry will be faithfully rendered but IFC information will be discarded
 +
* '''one Part shape per floor''', one all-in-one object, just for reference
 +
 
 +
<!--T:50-->
 +
Each of these types loses some information over the previous one, but is lighter on resources, which allows to open bigger files. A last type allows to discard entirely the importing of Arch objects, which is useful for structural analytic models.  
  
 
<!--T:41-->
 
<!--T:41-->
Line 56: Line 63:
  
 
<!--T:44-->
 
<!--T:44-->
Quantities specified in the IFC file are '''NOT''' imported. However, since the geometry is fully recreated in FreeCAD, most of the quantities such as length, area, etc.. are easily obtainable for each object
+
Quantities specified in the IFC file are '''NOT''' imported. However, since the geometry is fully recreated in FreeCAD, most of the quantities such as length, area, etc. are easily obtainable for each object.
  
 
<!--T:15-->
 
<!--T:15-->
Line 62: Line 69:
  
 
<!--T:45-->
 
<!--T:45-->
'''Note''': The BIM Workbench features an [[BIM IfcExplorer|IFC explorer]] tool that allows you to open an IFC file in fast, text-only mode, and import only the parts you wish.
+
'''Note''': The BIM Workbench features an [[BIM_IfcExplorer|IFC explorer]] tool that allows you to open an IFC file in fast, text-only mode, and import only the parts you wish.
  
 
== Exporting == <!--T:9-->
 
== Exporting == <!--T:9-->
  
 
<!--T:10-->
 
<!--T:10-->
Exporting to IFC files will export all the selected objects and their descendants. All Arch/BIM objects are supported, as well as other objects created in other workbenches. The only not fully supported objects, at the moment, are PartDesign bodies, App Parts, and new structures such as Links and LinkGroups, so you will need a bit of testing if using them. [[Arch Reference|Arch References]] will currently export as IfcBuildingElementProxies.
+
Exporting to IFC files will export all the selected objects and their descendants. All Arch/BIM objects are supported, as well as other objects created in other workbenches. The only not fully supported objects, at the moment, are {{Button|[[File:PartDesign_Body.svg|16px]] [[PartDesign_Body|PartDesign Bodies]]}}, {{Button|[[File:Std_Part.svg|16px]] [[Std_Part|Std Parts]]}}, and new structures such as {{Button|[[File:Link.svg|16px]] [[Std_LinkMake|App Links]]}} and {{Button|[[File:LinkGroup.svg|16px]] LinkGroups}}, so you will need a bit of testing if using them. [[Arch_Reference|Arch References]] will currently export as {{incode|IfcBuildingElementProxies}}.
  
 
<!--T:46-->
 
<!--T:46-->
Line 78: Line 85:
 
If the shape of exported objects is based on an extrusion or a boolean operation, the operation and components will be correctly exported to IFC. If not, the object's shape is exported as [http://www.buildingsmart-tech.org/ifc/IFC4x1/html/schema/ifcgeometricmodelresource/lexical/ifcfacetedbrep.htm IfcFacetedBrep]. If the shape contains curves, these will be triangulated. However, IfcOpenShell v0.5 or above feature a serializer, which must be enabled in the Import/Export → IFC preferences. If enabled, this serializer is able to export very complex curved objects such as those based on NURBS, and thus avoid triangulated faces. At the time of writing, though, few other BIM applications support IFC NURBS objects, so a bit of testing is advised.
 
If the shape of exported objects is based on an extrusion or a boolean operation, the operation and components will be correctly exported to IFC. If not, the object's shape is exported as [http://www.buildingsmart-tech.org/ifc/IFC4x1/html/schema/ifcgeometricmodelresource/lexical/ifcfacetedbrep.htm IfcFacetedBrep]. If the shape contains curves, these will be triangulated. However, IfcOpenShell v0.5 or above feature a serializer, which must be enabled in the Import/Export → IFC preferences. If enabled, this serializer is able to export very complex curved objects such as those based on NURBS, and thus avoid triangulated faces. At the time of writing, though, few other BIM applications support IFC NURBS objects, so a bit of testing is advised.
  
==Links== <!--T:18-->
+
== Further information == <!--T:18-->
Tutorial [[Import/Export_IFC_-_compiling_IfcOpenShell|Import/Export IFC - compiling IfcOpenShell]]
+
 
 +
<!--T:51-->
 +
* [[IfcOpenShell|IfcOpenShell]], more information on installing this library.
  
 
<!--T:19-->
 
<!--T:19-->
{{docnav
+
{{Docnav
 
|
 
|
|[[Arch DAE|DAE]]
+
|[[Arch_DAE|DAE]]
 
|[[Arch_Module|Arch Module]]
 
|[[Arch_Module|Arch Module]]
 
}}
 
}}
Line 90: Line 99:
 
</translate>
 
</translate>
 
{{Arch Tools navi{{#translation:}}}}
 
{{Arch Tools navi{{#translation:}}}}
 
 
{{Userdocnavi{{#translation:}}}}
 
{{Userdocnavi{{#translation:}}}}
 
 
[[Category:File Formats{{#translation:}}]]
 
[[Category:File Formats{{#translation:}}]]

Latest revision as of 03:57, 20 September 2020

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎svenska • ‎čeština • ‎русский

Description

The Workbench Arch.svg Arch and Workbench BIM.svg BIM Workbenches feature an Industry Foundation Classes (IFC) importer and exporter. The IFC format is a continuously growing format to interchange data among BIM applications, used in architecture and engineering.

Both the importer and exporter depend on the IfcOpenShell library, which is bundled in some distributions of FreeCAD. An easy way to check if IfcOpenShell is available is to enter the following in the Python console:

import ifcopenshell

If no error message appears, IfcOpenShell is installed, and you may proceed with importing IFC files. Otherwise, you will need to install IfcOpenShell yourself; read the IfcOpenShell page to learn more about this process.

Note: the BIM Setup.svg BIM Setup tool will look for IfcOpenShell too, and issue a notification if it is not installed.

Note 2: in the past (2013) the Arch Workbench used to feature a simpler IFC importer that didn't depend on IfcOpenShell. This legacy module is still included in the source code but as of v0.19 it is not recommended at all; it will only be able to import a very small subset of IFC objects, and should be considered completely obsolete.

Importing

All IfcProduct-based entities from IFC2x3 or IFC4 files will be imported into the FreeCAD document. The IFC preferences settings allow you to set how the IFC objects are imported:

  • full parametric Arch objects, the geometry will, as much as possible, be editable in FreeCAD
  • non-parametric Arch objects, objects will carry IFC information and properties but will not be editable
  • non-parametric Part shapes, the geometry will be faithfully rendered but IFC information will be discarded
  • one Part shape per floor, one all-in-one object, just for reference

Each of these types loses some information over the previous one, but is lighter on resources, which allows to open bigger files. A last type allows to discard entirely the importing of Arch objects, which is useful for structural analytic models.

Typically, if you try to open a large file and FreeCAD takes too long to import it, try with a lower import mode.

IfcOpenShell supports all IFC2x3 and IFC4 entities (IFC4-add1 and IFC4-add2 are being implemented in v0.6 and might be available by the time you read this) but not all of them can be converted to Arch objects, those that can't will be imported as simple Part shapes. The IFC importer starts by importing all IFC entities derived from IfcProduct, that is, basically, all the objects that compose a building, such as walls or windows or pipes. All other entities needed by one of these objects, such as profiles of extrusion, or components of boolean operations, will be imported as required.

If using an import mode that uses Arch objects, being parametric or not, all objects will carry the full set of IfcProperties attached to each object, grouped by Property Set.

Building structures such as Sites, Buildings and Storeys are also faithfully imported and the structure is correctly recreated in FreeCAD. Group structures (using IfcGroups) are also imported and rendered in FreeCAD, and can be combined with building structures, for ex. having groups inside storeys or storeys inside groups.

IfcAnnotation objects are also imported, as well as linear and curve-based IfcStructuralItem-based entities.

Quantities specified in the IFC file are NOT imported. However, since the geometry is fully recreated in FreeCAD, most of the quantities such as length, area, etc. are easily obtainable for each object.

Enabling the show debug messages in the IFC preferences settings will print a report indicating if any object from the IFC file failed to import.

Note: The BIM Workbench features an IFC explorer tool that allows you to open an IFC file in fast, text-only mode, and import only the parts you wish.

Exporting

Exporting to IFC files will export all the selected objects and their descendants. All Arch/BIM objects are supported, as well as other objects created in other workbenches. The only not fully supported objects, at the moment, are PartDesign Body.svg PartDesign Bodies, Std Part.svg Std Parts, and new structures such as Link.svg App Links and LinkGroup.svg LinkGroups, so you will need a bit of testing if using them. Arch References will currently export as IfcBuildingElementProxies.

To export a whole site or building or a whole floor or a group containing other objects, it is only needed to select that building or floor or group. Arch objects will be exported with the type set in their "IFC Type" property. Their IfcProperties are exported as well, and if these objects have an IFC UID from a previous import, the same UID will be kept at export. Objects that are not Arch objects are exported as IfcBuildingElementProxy.

IFC files are exported as IFC2x3 or IFC4 depending on your version of IfcOpenShell, which can be compiled with any of the IFC schemas. If using IfcOpenShell v0.6 or higher, the IFC version specified in the Arch preferences will be used.

If the shape of exported objects is based on an extrusion or a boolean operation, the operation and components will be correctly exported to IFC. If not, the object's shape is exported as IfcFacetedBrep. If the shape contains curves, these will be triangulated. However, IfcOpenShell v0.5 or above feature a serializer, which must be enabled in the Import/Export → IFC preferences. If enabled, this serializer is able to export very complex curved objects such as those based on NURBS, and thus avoid triangulated faces. At the time of writing, though, few other BIM applications support IFC NURBS objects, so a bit of testing is advised.

Further information