Difference between revisions of "Arch BuildingPart"

From FreeCAD Documentation
Jump to navigation Jump to search
(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 VIEWShow Level is True.)
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
 
<translate>
 
<translate>
 +
 
<!--T:16-->
 
<!--T:16-->
{{docnav|[[Arch_Floor|Floor]]|[[Arch_Building|Building]]|[[Arch_Module|Arch]]|IconL=Arch_Floor.svg |IconC=Workbench_Arch.svg |IconR=Arch_Building.svg}}
+
{{Docnav
 +
|[[Arch_Floor|Floor]]
 +
|[[Arch_Building|Building]]
 +
|[[Arch_Workbench|Arch]]
 +
|IconL=Arch_Floor.svg
 +
|IconR=Arch_Building.svg
 +
|IconC=Workbench_Arch.svg
 +
}}
  
 
<!--T:1-->
 
<!--T:1-->
Line 8: Line 16:
 
|Name=Arch BuildingPart
 
|Name=Arch BuildingPart
 
|MenuLocation=Arch → BuildingPart
 
|MenuLocation=Arch → BuildingPart
|Workbenches=[[Arch Module|Arch]]
+
|Workbenches=[[Arch_Workbench|Arch]]
|SeeAlso=[[Arch Building]], [[Arch Site]]
 
 
|Version=0.18
 
|Version=0.18
 +
|SeeAlso=[[Arch_Building|Arch Building]], [[Arch_Site|Arch Site]]
 
}}
 
}}
  
Line 16: Line 24:
  
 
<!--T:3-->
 
<!--T:3-->
The BuildingPart 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.
+
The BuildingPart replaces the old [[Arch Floor|Arch Floor]] and [[Arch Building|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.
  
==How to use== <!--T:4-->
+
==Usage== <!--T:4-->
  
 
<!--T:5-->
 
<!--T:5-->
 
# Optionally, select one or more objects to be included in your new Building Part.
 
# Optionally, select one or more objects to be included in your new Building Part.
# Press the {{Button|[[Image:Arch BuildingPart.svg|16px]] [[Arch BuildingPart]]}} button.
+
# Press the {{Button|[[Image:Arch BuildingPart.svg|16px]] [[Arch BuildingPart|Arch BuildingPart]]}} button.
 +
 
 +
=== Notes === <!--T:20-->
 +
 
 +
<!--T:21-->
 +
BuildingParts have a built-in, implicit [[Arch_SectionPlane|Arch SectionPlane]]. {{Version|0.19}}
 +
 
 +
<!--T:22-->
 +
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|Draft Shape2DView]] and [[TechDraw_ArchView|TechDraw ArchView]] also work with BuildingParts.
  
 
==Options== <!--T:6-->
 
==Options== <!--T:6-->
  
 
<!--T:7-->
 
<!--T:7-->
* After creating a BuildingPart, you can add more objects to it by dragging and dropping them in the Tree View or by using the {{Button|[[Image:Arch Add.svg|16px]] [[Arch Add]]}} tool.
+
* After creating a BuildingPart, you can add more objects to it by dragging and dropping them in the Tree View or by using the {{Button|[[Image:Arch Add.svg|16px]] [[Arch Add|Arch Add]]}} tool.
* You can remove objects from a BuildingPart by dragging and dropping them out of the Tree View or by using the {{Button|[[Image:Arch Remove.svg|16px]] [[Arch Remove]]}} tool.
+
* You can remove objects from a BuildingPart by dragging and dropping them out of the Tree View or by using the {{Button|[[Image:Arch Remove.svg|16px]] [[Arch Remove|Arch Remove]]}} tool.
* By double-clicking the BuildingPart object in the tree view, the [[Draft SelectPlane|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.
+
* By double-clicking the BuildingPart object in the tree view, the [[Draft SelectPlane|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 (in version 0.19, 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.
 
* 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 {{PropertyData|Move With Host}} property, or have it turned on, will move/rotate together.
 
* When a BuildingPart is moved/rotated, all its children that either have no {{PropertyData|Move With Host}} property, or have it turned on, will move/rotate together.
* Building Parts can be [[Draft Clone]]d.
+
* Building Parts can be [[Draft Clone|Draft Clone]]d.
* Building Parts can take any IFC type. Its '''IFC Role''' 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 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. {{Version|0.20}}
  
 
==Properties== <!--T:8-->
 
==Properties== <!--T:8-->
Line 41: Line 58:
 
* {{PropertyData|LevelOffset}}: The level of the (0,0,0) point of this level. This value is added to the {{incode|Placement.Base.z}} attribute of the BuildingPart, to indicate a vertical offset without actually moving the object. The resulting offset is displayed if {{PropertyView|Show Level}} is {{TRUE}}.
 
* {{PropertyData|LevelOffset}}: The level of the (0,0,0) point of this level. This value is added to the {{incode|Placement.Base.z}} attribute of the BuildingPart, to indicate a vertical offset without actually moving the object. The resulting offset is displayed if {{PropertyView|Show Level}} is {{TRUE}}.
 
* {{PropertyData|Area}}: The computed floor area of this floor
 
* {{PropertyData|Area}}: The computed floor area of this floor
* {{PropertyData|IfcRole}}: The role of this object
+
* {{PropertyData|IfcType}}: The IFC type of this object
 
* {{PropertyData|Description}}: An optional description for this component
 
* {{PropertyData|Description}}: An optional description for this component
 
* {{PropertyData|Tag}}: An optional tag for this component
 
* {{PropertyData|Tag}}: An optional tag for this component
Line 67: Line 84:
 
* {{PropertyView|ChildrenShapeColor}}: The shape color to apply to the children of this Building Part
 
* {{PropertyView|ChildrenShapeColor}}: The shape color to apply to the children of this Building Part
 
* {{PropertyView|ChildrenTransparency}}: The transparency to apply to the children of this Building Part
 
* {{PropertyView|ChildrenTransparency}}: The transparency to apply to the children of this Building Part
 +
 +
{{Version|0.20}}
 +
* {{PropertyView|AutogroupSize}}: The capture box for newly created objects expressed as [XMin,YMin,ZMin,XMax,YMax,ZMax]
 +
* {{PropertyView|AutogroupBox}}: Turns auto grouping (and the display of the capture box) on/off
 +
* {{PropertyView|AutogroupAutosize}}: Automatically set the capture box size from the Building Part contents
 +
* {{PropertyView|AutogroupMargin}}: A margin to use when autosize is turned on
 +
  
 
==Scripting== <!--T:10-->
 
==Scripting== <!--T:10-->
{{Emphasis|See also:}} [[Arch API]] and [[FreeCAD Scripting Basics]].
+
{{Emphasis|See also:}} [[Arch API|Arch API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
  
 
<!--T:11-->
 
<!--T:11-->
The BuildingPart tool can be used in [[macros]] and from the [[Python]] console by using the following function:
+
The BuildingPart tool can be used in [[macros|macros]] and from the [[Python|Python]] console by using the following function:
 +
 
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
Line 105: Line 130:
 
}}
 
}}
 
<translate>
 
<translate>
 +
 +
 
<!--T:14-->
 
<!--T:14-->
{{docnav|[[Arch_Floor|Floor]]|[[Arch_Building|Building]]|[[Arch_Module|Arch]]|IconL=Arch_Floor.svg |IconC=Workbench_Arch.svg |IconR=Arch_Building.svg}}
+
{{Docnav
 
+
|[[Arch_Floor|Floor]]
<!--T:17-->
+
|[[Arch_Building|Building]]
{{Arch Tools navi}}
+
|[[Arch_Workbench|Arch]]
 +
|IconL=Arch_Floor.svg
 +
|IconR=Arch_Building.svg
 +
|IconC=Workbench_Arch.svg
 +
}}
  
<!--T:18-->
 
{{Userdocnavi}}
 
 
</translate>
 
</translate>
 +
{{Arch Tools navi{{#translation:}}}}
 +
{{Userdocnavi{{#translation:}}}}

Revision as of 12:54, 14 October 2021

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎română • ‎русский
Arrow-left.svg Previous: Arch Floor.svg Floor
Next: Building Arch Building.svg Arrow-right.svg

Arch BuildingPart.svg Arch BuildingPart

Menu location
Arch → BuildingPart
Workbenches
Arch
Default shortcut
None
Introduced in version
0.18
See also
Arch Building, Arch Site

Description

The BuildingPart 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

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

Notes

BuildingParts have a built-in, implicit Arch SectionPlane. introduced in version 0.19

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.svg 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.svg 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 (in version 0.19, 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 DataMove 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. introduced in version 0.20

Properties

Data

  • DataHeight: 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.
  • DataLevelOffset: 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 ViewShow Level is true.
  • DataArea: The computed floor area of this floor
  • DataIfcType: The IFC type of this object
  • DataDescription: An optional description for this component
  • DataTag: An optional tag for this component
  • DataIfcAttributes: Custom IFC properties and attributes

View

  • ViewLineWidth: The line width of this object
  • ViewOverrideUnit: An optional unit to express levels
  • ViewDisplayOffset: A transformation to apply to the level mark
  • ViewShowLevel: If true, show the level
  • ViewShowUnit: If true, show the unit on the level tag
  • ViewSetWorkingPlane: If true, when activated, the working plane will automatically adapt to this Building Part
  • ViewOriginOffset: If true, when activated, Display offset will affect the origin mark too
  • ViewShowLabel: If true, when activated, the object's label is displayed
  • ViewFontName: The font to be used for texts
  • ViewFontSize: The font size of texts
  • ViewRestoreView: If set, the view stored in this object will be restored on double-click
  • ViewDiffuseColor: The individual face colors

introduced in version 0.19

  • ViewChildrenOverride: If set, the settings below will affect the children of this Building Part
  • ViewChildrenLineWidth: The line width to apply to the children of this Building Part
  • ViewChildrenLineColor: The line color to apply to the children of this Building Part
  • ViewChildrenShapeColor: The shape color to apply to the children of this Building Part
  • ViewChildrenTransparency: The transparency to apply to the children of this Building Part

introduced in version 0.20

  • ViewAutogroupSize: The capture box for newly created objects expressed as [XMin,YMin,ZMin,XMax,YMax,ZMax]
  • ViewAutogroupBox: Turns auto grouping (and the display of the capture box) on/off
  • ViewAutogroupAutosize: Automatically set the capture box size from the Building Part contents
  • ViewAutogroupMargin: A margin to use when autosize is turned on


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()


Arrow-left.svg Previous: Arch Floor.svg Floor
Next: Building Arch Building.svg Arrow-right.svg