GuiCommand: Name: Arch BuildingPart MenuLocation: Arch , BuildingPart, 3D/BIM , Level Workbenches: Arch_Workbench Version: 0.18 SeeAlso: Arch_Building, Arch_Site

Arch BuildingPart

Description

The BuildingPart object, produced by the BIM Level or BIM Building commands, replaces the old Arch Floor and Arch Building with a more capable version that can be used not only to create Floor/Storey/Levels but also all kinds of situations where different Arch/BIM objects need to be grouped and that group might need to be handled as one object or replicated.

Usage

Optionally, select one or more objects to be included in your new Building Part.
Press the Arch BuildingPart button.

Notes

BuildingParts have a built-in, implicit Arch SectionPlane.

This plane is always parallel to the BuildingPart\'s base plane, but you can specify the offset between them. So all tools that work with a section plane, such as Draft Shape2DView and TechDraw ArchView also work with BuildingParts.

Options

After creating a BuildingPart, you can add more objects to it by dragging and dropping them in the Tree View or by using the Arch Add tool.
You can remove objects from a BuildingPart by dragging and dropping them out of the Tree View or by using the Arch Remove tool.
By double-clicking the BuildingPart object in the tree view, the Working Plane will be set to its location, and the BuildingPart will become active, which means that new objects will be added automatically to it. Double-clicking the BuildingPart again will deactivate it and set the working plane back to its previous position (to be available this option needs to be set up as true, in View Property panel - Interaction - Double Click Activates).
The BuildingPart can display a mark in the 3D view with a label and level indication.
When a BuildingPart is moved/rotated, all its children that either have no Move With Host property, or have it turned on, will move/rotate together.
Building Parts can be Draft Cloned.
Building Parts can take any IFC type. Its IFC Type property determines its use. If you set it to Building Storey it will behave as a level. If you set it to Building it behaves as a building, and if you set it to Element Assembly it behaves as an assembly. Its icon will change to reflect this setting, but other than that it has no other impact in FreeCAD. However, being exported to IFC as one or another type can have an impact in other BIM applications.
Building Parts allow to define an Auto-group capture box. Subsequent Draft and Arch objects, or anything else that uses Draft.autogroup(), will be automatically added to that Building Part if they are fully inside the capture box. (v0.20)

Properties

Data

Group|LinkList: List of referenced objects.
_ Group Touched|Bool|Hidden

Area|Area: The computed floor area of this floor.
Height|Length: The height of this object, and of its children objects. The children objects could be, for example, Arch Walls. Each wall\'s height must be set to 0 (zero), so the height property of the BuildingPart propagates to the objects inside of it.
Level Offset|Length: The level of the (0,0,0) point of this level. This value is added to the Placement.Base.z attribute of the BuildingPart, to indicate a vertical offset without actually moving the object. The resulting offset is displayed if Show Level is True.
Materials Table|Map|Hidden: A MaterialName:SolidIndexesList map that relates material names with solid indexes to be used when referencing this object from other files.
Only Solids|Bool: If true, only solids will be collected by this object when referenced from other files.
Saved Inventor|FileIncluded|Hidden: This property stores an inventor representation for this object.
Shape|PartShape|Hidden: The shape of this object.

Height Propagate|Bool: If true, the height value propagates to contained objects. See the Height property for additional conditions that apply.

Ifc Data|Map|Hidden: IFC data.
Ifc Properties|Map|Hidden: IFC properties of this object.
Ifc Type|Enumeration: The IFC type of this object.

Description|String: An optional description for this component
Global Id|String
Object Type|String
Overall Height|Length
Overall Width|Length
Partitioning Type|Enumeration
Predefined Type|Enumeration
Tag|String: An optional tag for this component.
User Defined Partitioning Type|String

View

Autogroup Autosize|Bool: Automatically set the capture box size from the Building Part contents. (v0.20)
Autogroup Box|Bool: Turns auto grouping (and the display of the capture box) on/off. (v0.20)
Autogroup Margin|Length: A margin to use when autosize is turned on. (v0.20)
Autogroup Size|IntegerList: The capture box for newly created objects expressed as [XMin,YMin,ZMin,XMax,YMax,ZMax]. (v0.20)

Diffuse Color|ColorList|Hidden: The individual face colors.
Display Offset|Placement: A transformation to apply to the level mark.
Font Name|Font: The font to be used for texts.
Font Size|Length: The font size of texts.
Line Width|Float: The line width of this object.
Origin Offset|Bool: If true, when activated, Display offset will affect the origin mark too.
Override Unit|String: An optional unit to express levels.
Show Label|Bool: If true, when activated, the object\'s label is displayed.
Show Level|Bool: If true, show the level.
Show Unit|Bool: If true, show the unit on the level tag.

Children Line Color|Color: The line color to apply to the children of this Building Part.
Children Line Width|Float: The line width to apply to the children of this Building Part.
Children Override|Bool: If true, the objects contained in this Building Part will adopt these line, color and transparency settings.
Children Shape Color|Color: The shape color to apply to the children of this Building Part.
Children Transparency|Percent: The transparency to apply to the children of this Building Part.

Auto Cut View|Bool: Turn cutting on when activating this level.
Cut Margin|Length: The distance between the level plane and the cut line.
Cut View|Bool: Cut the view above this level.

Auto Working Plane|Bool: If set to True, the working plane will be kept on Auto mode.
Double Click Activates|Bool: If True, double-clicking this object in the tree activates it.
Restore View|Bool: If set, the view stored in this object will be restored on double-click.
Save Inventor|Bool: If this is enabled, the inventor representation of this object will be saved in the FreeCAD file, allowing to reference it in other files in lightweight mode.
Saved Inventor|FileIncluded|Hidden: A slot to save the inventor representation of this object, if enabled.
Set Working Plane|Bool: If true, when activated, the working plane will automatically adapt to this Building Part.
View Data|FloatList|Hidden: Camera position data associated with this object.

Scripting

See also:

Arch API and FreeCAD Scripting Basics.

The BuildingPart tool can be used in macros and from the Python console by using the following function:

BuildingPart = makeBuildingPart(objectslist=None)

Creates a BuildingPart object from objectslist, which is a list of objects.

Example:

import FreeCAD, Draft, Arch

p1 = FreeCAD.Vector(0, 0, 0)
p2 = FreeCAD.Vector(2000, 0, 0)
baseline = Draft.makeLine(p1, p2)
baseline2 = Draft.makeLine(p1, -1*p2)

Wall1 = Arch.makeWall(baseline, length=None, width=150, height=2000)
Wall2 = Arch.makeWall(baseline2, length=None, width=150, height=1800)
FreeCAD.ActiveDocument.recompute()

BuildingPart = Arch.makeBuildingPart([Wall1, Wall2])

Floor = Arch.makeFloor([BuildingPart])
Building = Arch.makeBuilding([Floor])
Site = Arch.makeSite(Building)
FreeCAD.ActiveDocument.recompute()

⏵ documentation index > BIM > Arch BuildingPart

This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Arch_BuildingPart.md

Donate