Arch Stairs: Difference between revisions

From FreeCAD Documentation
No edit summary
m (Linted templates)
(29 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:23-->
{{GuiCommand|Name=Arch Stairs|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Stairs|Shortcut=S R}}
{{Docnav
|[[Arch_Space|Space]]
|[[Arch_CompPanel|Arch CompPanel]]
|[[Arch_Module|Arch]]
|IconL=Arch_Space.svg
|IconC=Workbench_Arch.svg
|IconR=Arch_CompPanel.png
}}

<!--T:19-->
{{GuiCommand
|Name=Arch Stairs
|MenuLocation=Arch → Stairs
|Workbenches=[[Arch Module|Arch]]
|Shortcut={{KEY|S}} {{KEY|R}}
|SeeAlso=[[Arch Structure]], [[Arch Equipment]]
|Version=0.14
}}

==Description== <!--T:1-->
==Description== <!--T:1-->
The stairs tool allows you to build automatically several types of stairs. At the moment, only straight stairs (with or without a central landing) are supported. Stairs can be built from scratch, or from a straight [[Draft Line|line]], in which case the stairs follow the line. If the line is not horizontal but has a vertical inclination, the stairs will also follow its slope.
The [[Arch Stairs]] tool allows you to build automatically several types of stairs. At the moment, only straight stairs (with or without a central landing) are supported. Stairs can be built from scratch, or from a straight [[Draft Line|line]], in which case the stairs follow the line. If the line is not horizontal but has a vertical inclination, the stairs will also follow its slope.


<!--T:9-->
See the [http://en.wikipedia.org/wiki/Stairs Stairs entry in wikipedia] for a definition of the different terms used to describe parts of stairs.
See the [http://en.wikipedia.org/wiki/Stairs Stairs entry in wikipedia] for a definition of the different terms used to describe parts of stairs.


Line 9: Line 30:
[[Image:Arch Stairs example.jpg|640px]]
[[Image:Arch Stairs example.jpg|640px]]
<translate>
<translate>

<!--T:7-->
<!--T:7-->
On the above image, two stairs were created, one with a massive structure and a landing, and another one with a single stringer.
{{Caption|Two constructed stairs, one with a massive structure and a landing, and another one with a single stringer.}}

==Options== <!--T:20-->

<!--T:21-->
* Stairs share the common properties and behaviours of all [[Arch Component|Arch Components]]


==How to use== <!--T:2-->
==Usage== <!--T:2-->
# Press the {{KEY|[[Image:Arch_Stairs.png|16px]] [[Arch Stairs]]}} button, or press {{KEY|S}}, {{KEY|R}} keys
# Press the {{Button|[[Image:Arch_Stairs.svg|16px]] [[Arch Stairs]]}} button, or press {{KEY|S}}, {{KEY|R}} keys.
# Adjust the desired properties. Some parts of the stairs, such as the structure, might not appear immediately, if any of the properties makes it impossible, such as a structure thickness of 0.
# Adjust the desired properties. Some parts of the stairs, such as the structure, might not appear immediately, if any of the properties makes it impossible, such as a structure thickness of 0.


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


<!--T:3-->
<!--T:3-->
Base
Base


<!--T:10-->
* {{PropertyData|Align}}: The alignment of these stairs on their baseline, if applicable.
* {{PropertyData|Align}}: The alignment of these stairs on their baseline, if applicable.
* {{PropertyData|Base}}: The baseline of these stairs, if any.
* {{PropertyData|Base}}: The baseline of these stairs, if any.
Line 28: Line 54:
* {{PropertyData|Width}}: The width of these stairs.
* {{PropertyData|Width}}: The width of these stairs.


<!--T:11-->
Steps
Steps


<!--T:12-->
* {{PropertyData|Nosing}}: The size of the nosing.
* {{PropertyData|Nosing}}: The size of the nosing.
* {{PropertyData|Number of Steps}}: The numbers of steps (risers) in these stairs.
* {{PropertyData|Number of Steps}}: The numbers of steps (risers) in these stairs.
Line 36: Line 64:
* {{PropertyData|Tread Thickness}}: The thickness of the treads.
* {{PropertyData|Tread Thickness}}: The thickness of the treads.


<!--T:13-->
Structure
Structure


<!--T:14-->
* {{PropertyData|Landings}}: The type of landings.
* {{PropertyData|Landings}}: The type of landings.
* {{PropertyData|Stringer Offset}}: The offset between the border of the stairs and the structure.
* {{PropertyData|Stringer Offset}}: The offset between the border of the stairs and the structure.
Line 45: Line 75:
* {{PropertyData|Winders}}: The type of winders.
* {{PropertyData|Winders}}: The type of winders.


==Limitations== <!--T:5-->
== Scripting ==
* Only straight stairs are available at the moment
* See the [http://forum.freecadweb.org/viewtopic.php?f=23&t=6534 forum entry] for circle stairs.
* See the [http://forum.freecadweb.org/viewtopic.php?f=9&t=4564 forum announcement].


== Scripting == <!--T:15-->
Stairs can be created from python scripts and [[macros]] by using the following function:
{{Emphasis|See also:}} [[Arch API]] and [[FreeCAD Scripting Basics]].


<!--T:16-->
The Stairs tool can be used in [[macros]] and from the [[Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
<syntaxhighlight>
makeStairs([base], [length], [width], [height], [steps])
Stairs = makeStairs(baseobj=None, length=None, width=None, height=None, steps=None, name="Stairs")
}}
</syntaxhighlight>
<translate>
<translate>


<!--T:17-->
* Creates a stairs object with the given attributes.
* Creates a {{incode|Stairs}} object from the given {{incode|baseobj}}.
* Returns the new stairs object.
* If {{incode|baseobj}} is not given, it will use {{incode|length}}, {{incode|width}}, {{incode|height}}, and {{incode|steps}}, to build a solid object.


<!--T:18-->
Example:
Example:

</translate>
</translate>
{{Code|code=
<syntaxhighlight>
import Arch
import Arch

makeStairs(length=5, width=1.2, height=3, steps=14)
Stairs = Arch.makeStairs(length=5000, width=1200, height=3000, steps=14)
</syntaxhighlight>
}}
<translate>
<translate>


==Limitations== <!--T:5-->
<!--T:22-->
{{Docnav
* Not available before FreeCAD version 0.14
|[[Arch_Space|Space]]
* Only straight stairs are available at the moment
|[[Arch_CompPanel|Arch CompPanel]]
* See the [http://forum.freecadweb.org/viewtopic.php?f=9&t=4564 forum announcement].
|[[Arch_Module|Arch]]
|IconL=Arch_Space.svg
|IconC=Workbench_Arch.svg
|IconR=Arch_CompPanel.png
}}

</translate>
</translate>
{{Arch Tools navi{{#translation:}}}}

{{Userdocnavi{{#translation:}}}}
{{clear}}

<languages/>

Revision as of 18:46, 21 February 2020

Arch Stairs

Menu location
Arch → Stairs
Workbenches
Arch
Default shortcut
S R
Introduced in version
0.14
See also
Arch Structure, Arch Equipment

Description

The Arch Stairs tool allows you to build automatically several types of stairs. At the moment, only straight stairs (with or without a central landing) are supported. Stairs can be built from scratch, or from a straight line, in which case the stairs follow the line. If the line is not horizontal but has a vertical inclination, the stairs will also follow its slope.

See the Stairs entry in wikipedia for a definition of the different terms used to describe parts of stairs.

Two constructed stairs, one with a massive structure and a landing, and another one with a single stringer.

Options

Usage

  1. Press the Arch Stairs button, or press S, R keys.
  2. Adjust the desired properties. Some parts of the stairs, such as the structure, might not appear immediately, if any of the properties makes it impossible, such as a structure thickness of 0.

Properties

Base

  • DataAlign: The alignment of these stairs on their baseline, if applicable.
  • DataBase: The baseline of these stairs, if any.
  • DataHeight: The total height of these stairs, if not based on a baseline, or the baseline is horizontal.
  • DataLength: The total length of these stairs if no baseline is defined.
  • DataWidth: The width of these stairs.

Steps

  • DataNosing: The size of the nosing.
  • DataNumber of Steps: The numbers of steps (risers) in these stairs.
  • DataRiser Height: The height of the risers.
  • DataTread Depth: The depth of the treads.
  • DataTread Thickness: The thickness of the treads.

Structure

  • DataLandings: The type of landings.
  • DataStringer Offset: The offset between the border of the stairs and the structure.
  • DataStringer Width: The width of the stringers.
  • DataStructure: The type of structure of these stairs.
  • DataStructure Thickness: The thickness of the structure.
  • DataWinders: The type of winders.

Limitations

Scripting

See also: Arch API and FreeCAD Scripting Basics.

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

Stairs = makeStairs(baseobj=None, length=None, width=None, height=None, steps=None, name="Stairs")
  • Creates a Stairs object from the given baseobj.
  • If baseobj is not given, it will use length, width, height, and steps, to build a solid object.

Example:

import Arch

Stairs = Arch.makeStairs(length=5000, width=1200, height=3000, steps=14)