Arch Roof: Difference between revisions

From FreeCAD Documentation
(adding <translate>)
(Marked this version for translation)
Line 1: Line 1:
<translate>
<translate>
<!--T:1-->
{{GuiCommand|Name=Arch Roof|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch -> Roof|Shortcut=R F}}
{{GuiCommand|Name=Arch Roof|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch -> Roof|Shortcut=R F}}


==Description==
==Description== <!--T:2-->


<!--T:3-->
The Roof tool allows you to create a sloped roof from a selected face. Any face of any shape-based object can be used, and the created roof object is parametric, keeping its relationship with the base object. Please note that this tool is still in development, and might fail with very complex shapes.
The Roof tool allows you to create a sloped roof from a selected face. Any face of any shape-based object can be used, and the created roof object is parametric, keeping its relationship with the base object. Please note that this tool is still in development, and might fail with very complex shapes.
</translate>
</translate>
Line 10: Line 12:


<translate>
<translate>
==How to use==
==How to use== <!--T:4-->


<!--T:5-->
# Select an existing face
# Select an existing face
# Press the {{KEY|[[Image:Arch Roof.png|16px]] [[Arch Roof]]}} button, or press {{KEY|R}} then {{KEY|F}} keys
# Press the {{KEY|[[Image:Arch Roof.png|16px]] [[Arch Roof]]}} button, or press {{KEY|R}} then {{KEY|F}} keys


==Properties==
==Properties== <!--T:6-->


<!--T:7-->
* {{PropertyData|Angle}}: The slope angle of the roof
* {{PropertyData|Angle}}: The slope angle of the roof
* {{PropertyData|Face}}: The face index of the base object to be used
* {{PropertyData|Face}}: The face index of the base object to be used


==Scripting==
==Scripting== <!--T:8-->


<!--T:9-->
The Roof tool can by used in [[macros]] and from the python console by using the following function:
The Roof tool can by used in [[macros]] and from the python console by using the following function:
</translate>
</translate>
Line 28: Line 33:
</syntaxhighlight>
</syntaxhighlight>
<translate>
<translate>
<!--T:10-->
Makes a roof based on a face from an existing object. You can provide the number of the face to build the roof on (default = 1), the angle in degrees (default=45) and a name (default = roof).
Makes a roof based on a face from an existing object. You can provide the number of the face to build the roof on (default = 1), the angle in degrees (default=45) and a name (default = roof).


<!--T:11-->
Example:
Example:
</translate>
</translate>

Revision as of 13:10, 29 November 2013

Arch Roof

Menu location
Arch -> Roof
Workbenches
Arch
Default shortcut
R F
Introduced in version
-
See also
None

Description

The Roof tool allows you to create a sloped roof from a selected face. Any face of any shape-based object can be used, and the created roof object is parametric, keeping its relationship with the base object. Please note that this tool is still in development, and might fail with very complex shapes.

How to use

  1. Select an existing face
  2. Press the Arch Roof button, or press R then F keys

Properties

  • DataAngle: The slope angle of the roof
  • DataFace: The face index of the base object to be used

Scripting

The Roof tool can by used in macros and from the python console by using the following function:

makeRoof (baseobj,[facenr],[angle],[name])

Makes a roof based on a face from an existing object. You can provide the number of the face to build the roof on (default = 1), the angle in degrees (default=45) and a name (default = roof).

Example: <syntaxhighlight> import Arch, Draft rect = Draft.makeRectangle(2,4) Arch.makeRoof(rect,angle=30) <syntaxhighlight>