Arch Roof: Difference between revisions
m (Added template and clarity) |
No edit summary |
||
(4 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
<translate> |
<translate> |
||
<!--T:30--> |
<!--T:30--> |
||
{{ |
{{Docnav |
||
|[[Arch_Grid|Grid]] |
|[[Arch_Grid|Grid]] |
||
|[[Arch_Space|Space]] |
|[[Arch_Space|Space]] |
||
|[[Arch_Module|Arch]] |
|[[Arch_Module|Arch]] |
||
|IconL=Arch_Grid.svg |
|IconL=Arch_Grid.svg |
||
⚫ | |||
|IconR=Arch_Space.svg |
|IconR=Arch_Space.svg |
||
⚫ | |||
}} |
}} |
||
Line 15: | Line 15: | ||
|Name=Arch Roof |
|Name=Arch Roof |
||
|MenuLocation=Arch → Roof |
|MenuLocation=Arch → Roof |
||
|Workbenches=[[ |
|Workbenches=[[Arch_Module|Arch]] |
||
|Shortcut={{KEY|R}} {{KEY|F}} |
|Shortcut={{KEY|R}} {{KEY|F}} |
||
|SeeAlso=[[Arch Structure]], [[Arch Wall]] |
|SeeAlso=[[Arch_Structure|Arch Structure]], [[Arch_Wall|Arch Wall]] |
||
}} |
}} |
||
Line 23: | Line 23: | ||
<!--T:15--> |
<!--T:15--> |
||
The {{Button|[[Image:Arch Roof.svg|16px]] [[ |
The {{Button|[[Image:Arch Roof.svg|16px]] [[Arch_Roof|Arch Roof]]}} tool allows for the creation of a sloped roof from a selected wire. The created roof object is parametric, keeping its relationship with the base object. The principle is that each edge is seen allotting a profile of roof (slope, width, overhang, thickness). |
||
<!--T:29--> |
<!--T:29--> |
||
Line 37: | Line 37: | ||
<!--T:18--> |
<!--T:18--> |
||
# Create a wire with following the |
# Create a wire with following the counter-clockwise direction and select it. |
||
# |
#:[[Image:CounterclockwiseWire.png|600px]] |
||
# Press the {{Button|[[Image:Arch Roof.svg|16px]] [[Arch Roof]]}} button, or press {{KEY|R}} then {{KEY|F}} keys |
# Press the {{Button|[[Image:Arch Roof.svg|16px]] [[Arch Roof|Arch Roof]]}} button, or press {{KEY|R}} then {{KEY|F}} keys |
||
# The default roof object could have a strange shape, it's because the tool |
# The default roof object could have a strange shape, it's because the tool is missing some necessary information. |
||
# After creating the default roof, double click on the object in the tree view to access and edit all the properties. Angle must be between 0 and 90. |
# After creating the default roof, double click on the object in the [[tree view]] to access and edit all the properties. Angle must be between 0 and 90. |
||
# |
#:[[File:RoofTable.png]] |
||
# Each line |
# Each line corresponds to a roof pane. So you can set the properties you want for each roof pane. |
||
# To help you, you can set Angle or Run to 0 and |
# To help you, you can set {{incode|Angle}} or {{incode|Run}} to {{incode|0}} and define a {{incode|Relative Id}}, this makes an automatic calculation to find the data relative to the {{incode|Relative Id}}. |
||
# It |
# It works like this: |
||
## If Angle |
## If {{incode|Angle = 0}} and {{incode|Run = 0}} then profile is identical to the relative profile. |
||
## If Angle |
## If {{incode|Angle = 0}} then {{incode|Angle}} is calculated so that the height is the same one as the relative profile. |
||
## If Run |
## If {{incode|Run = 0}} then {{incode|Run}} is calculated so that the height is the same one as the relative profile. |
||
# |
# Finally, set an Angle to 90° to make a gable. |
||
# |
#:[[Image:RoofProfil.png|600px]] |
||
# |
# {{Emphasis|Note}}: for better comprehension, please see this [https://www.youtube.com/watch?v=4Urwru71dVk youtube clip]. |
||
==Options== <!--T:26--> |
==Options== <!--T:26--> |
||
<!--T:27--> |
<!--T:27--> |
||
* Roofs share the common properties and |
* Roofs share the common properties and behaviors of all [[Arch Component|Arch Components]] |
||
==Properties== <!--T:20--> |
==Properties== <!--T:20--> |
||
Line 63: | Line 63: | ||
* {{PropertyData|Angles}}: List of the slope angle of the roof pane (an angle for each edge in the wire). |
* {{PropertyData|Angles}}: List of the slope angle of the roof pane (an angle for each edge in the wire). |
||
* {{PropertyData|Runs}}: List of the width of the roof pane (a run for each edge in the wire). |
* {{PropertyData|Runs}}: List of the width of the roof pane (a run for each edge in the wire). |
||
* {{PropertyData|IdRel}}: List of relation Id |
* {{PropertyData|IdRel}}: List of relation Id of the slope angle of the roof. |
||
* {{PropertyData|Thickness}}: List of thickness of the roof pane. (a thickness for each edge in the wire). |
* {{PropertyData|Thickness}}: List of thickness of the roof pane. (a thickness for each edge in the wire). |
||
* {{PropertyData|Overhang}}: List of the overhang of the roof pane (an overhang for each edge in the wire). |
* {{PropertyData|Overhang}}: List of the overhang of the roof pane (an overhang for each edge in the wire). |
||
* {{PropertyData|Face}}: The face index of the base object to be used |
* {{PropertyData|Face}}: The face index of the base object to be used (not really used). |
||
==Scripting== <!--T:22--> |
==Scripting== <!--T:22--> |
||
{{Emphasis|See also:}} [[Arch API]] and [[FreeCAD Scripting Basics]]. |
{{Emphasis|See also:}} [[Arch API|Arch API]] and [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]]. |
||
<!--T:23--> |
<!--T:23--> |
||
The Roof tool can be used in [[macros]] and from the [[Python]] console by using the following function: |
The Roof 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 104: | Line 104: | ||
<translate> |
<translate> |
||
<!--T:28--> |
<!--T:28--> |
||
{{ |
{{Docnav |
||
|[[Arch_Grid|Grid]] |
|[[Arch_Grid|Grid]] |
||
|[[Arch_Space|Space]] |
|[[Arch_Space|Space]] |
||
|[[Arch_Module|Arch]] |
|[[Arch_Module|Arch]] |
||
|IconL=Arch_Grid.svg |
|IconL=Arch_Grid.svg |
||
⚫ | |||
|IconC=Workbench_Arch.svg |
|IconC=Workbench_Arch.svg |
||
⚫ | |||
}} |
}} |
||
<!--T:31--> |
|||
⚫ | |||
<!--T:32--> |
|||
⚫ | |||
</translate> |
</translate> |
||
⚫ | |||
⚫ |
Revision as of 14:20, 29 November 2020
Arch Roof |
Menu location |
---|
Arch → Roof |
Workbenches |
Arch |
Default shortcut |
R F |
Introduced in version |
- |
See also |
Arch Structure, Arch Wall |
Description
The Arch Roof tool allows for the creation of a sloped roof from a selected wire. The created roof object is parametric, keeping its relationship with the base object. The principle is that each edge is seen allotting a profile of roof (slope, width, overhang, thickness).
Note: This tool is still in development, and might fail with very complex shapes.
View from above a building model showing the roof with certain transparency
Usage
- Create a wire with following the counter-clockwise direction and select it.
- Press the Arch Roof button, or press R then F keys
- The default roof object could have a strange shape, it's because the tool is missing some necessary information.
- After creating the default roof, double click on the object in the tree view to access and edit all the properties. Angle must be between 0 and 90.
- Each line corresponds to a roof pane. So you can set the properties you want for each roof pane.
- To help you, you can set
Angle
orRun
to0
and define aRelative Id
, this makes an automatic calculation to find the data relative to theRelative Id
. - It works like this:
- If
Angle = 0
andRun = 0
then profile is identical to the relative profile. - If
Angle = 0
thenAngle
is calculated so that the height is the same one as the relative profile. - If
Run = 0
thenRun
is calculated so that the height is the same one as the relative profile.
- If
- Finally, set an Angle to 90° to make a gable.
- Note: for better comprehension, please see this youtube clip.
Options
- Roofs share the common properties and behaviors of all Arch Components
Properties
- DataAngles: List of the slope angle of the roof pane (an angle for each edge in the wire).
- DataRuns: List of the width of the roof pane (a run for each edge in the wire).
- DataIdRel: List of relation Id of the slope angle of the roof.
- DataThickness: List of thickness of the roof pane. (a thickness for each edge in the wire).
- DataOverhang: List of the overhang of the roof pane (an overhang for each edge in the wire).
- DataFace: The face index of the base object to be used (not really used).
Scripting
See also: Arch API and FreeCAD Scripting Basics.
The Roof tool can be used in macros and from the Python console by using the following function:
Roof = makeRoof(baseobj=None, facenr=0, angles=[45.,], run=[], idrel=[0,], thickness=[50.,], overhang=[100.,], name="Roof")
- Creates a
Roof
object from the givenbaseobj
, which can be a closed wire or a solid object.- If
baseobj
is a wire, you can provide lists forangles
,run
,idrel
,thickness
, andoverhang
, for each edge in the wire to define the shape of the roof. - The lists are automatically completed to match the number of edges in the wire.
- If
Example:
import FreeCAD, Arch, Draft
Rect = Draft.makeRectangle(3000, 4000)
Roof = Arch.makeRoof(Rect, angles=[30.,])
FreeCAD.ActiveDocument.recompute()
p1 = FreeCAD.Vector(0, 0, 0)
p2 = FreeCAD.Vector(1000, 1000, 0)
p3 = FreeCAD.Vector(0, 2000, 0)
Wire = Draft.makeWire([p1, p2, p3], closed=True)
Roof2 = Arch.makeRoof(Wire)
FreeCAD.ActiveDocument.recompute()
Arch
- Elements: Wall, Structure, Curtain Wall, Window, Roof, Space, Stairs, Equipment, Frame, Fence, Truss, Profile, Pipe, Pipe Connector
- Reinforcements: Straight Rebar, U-Shape Rebar, L-Shape Rebar, Stirrup, Bent-Shape Rebar, Helical Rebar, Column Reinforcement, Beam Reinforcement, Slab Reinforcement, Footing Reinforcement, Custom Rebar
- Panels: Panel, Panel Cut, Panel Sheet, Nest
- Materials: Material, Multi-Material
- Organization: Building Part, Project, Site, Building, Level, External reference, Section Plane, Schedule
- Axes: Axis, Axes system, Grid
- Modification: Cut with plane, Add component, Remove component, Survey
- Utilities: Component, Clone component, Split Mesh, Mesh to Shape, Select non-manifold meshes, Remove Shape from Arch, Close Holes, Merge Walls, Check, Toggle IFC Brep flag, 3 Views from mesh, Create IFC spreadsheet, Toggle Subcomponents
- Additional: Preferences, Import Export Preferences (IFC, DAE, OBJ, JSON, 3DS, SHP), IfcOpenShell, IfcPlusPlus, Arch API
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub