Arch Stairs: Difference between revisions

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


<!--T:19-->
[[File:Stairs_it.png|left]]
{{GuiCommand
{{clear}}
|Name=Arch Stairs
|MenuLocation=Arch → Stairs
|Workbenches=[[Arch_Module|Arch]]
|Shortcut={{KEY|S}} {{KEY|R}}
|Version=0.14
|SeeAlso=[[Arch_Structure|Arch Structure]], [[Arch_Equipment|Arch Equipment]]
}}


==Description== <!--T:1-->
==How to use==
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.
Press the {{KEY|[[Image:Arch_Stairs.png|32px]] Stairs}} button, or press {{KEY|S}}, {{KEY|R}} keys
{{clear}}
==Properties==
[[File:StairsProperties_it.png|left]]
===Data===
====Arch====
* {{PropertyData|Align}}:
* {{PropertyData|Base}}:
* {{PropertyData|Height}}:
* {{PropertyData|Length}}:
* {{PropertyData|Width}}:
====Base====
* {{PropertyData|Label}}:
* {{PropertyData|Placement}}:
====Steps====
* {{PropertyData|Noising}}:
* {{PropertyData|Number of risers}}:
* {{PropertyData|Riser Height}}:
* {{PropertyData|Tread Depth}}:
* {{PropertyData|Tread Thickness}}:
====Structure====
* {{PropertyData|Landigs}}:
* {{PropertyData|Stringer Offset}}:
* {{PropertyData|Stringer Width}}:
* {{PropertyData|Structure}}:
* {{PropertyData|Structure...}}:
* {{PropertyData|Winders}}:


<!--T:9-->
{{clear}}
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.


</translate>
[[Image:Arch Stairs example.jpg|640px]]
<translate>
<!--T:7-->
{{Caption|Two constructed stairs, one with a massive structure and a landing, and another one with a single stringer.}}


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


<!--T:21-->
==Limitation==
* Stairs share the common properties and behaviours of all [[Arch Component|Arch Components]]
See [http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=9&t=4564 Arch Stairs].


==Usage== <!--T:2-->
{{languages | {{fr|Arch_Stairs/fr}} {{it|Arch_Stairs/it}} }}
# 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.

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

<!--T:3-->
Base

<!--T:10-->
* {{PropertyData|Align}}: The alignment of these stairs on their baseline, if applicable.
* {{PropertyData|Base}}: The baseline of these stairs, if any.
* {{PropertyData|Height}}: The total height of these stairs, if not based on a baseline, or the baseline is horizontal.
* {{PropertyData|Length}}: The total length of these stairs if no baseline is defined.
* {{PropertyData|Width}}: The width of these stairs.

<!--T:11-->
Steps

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

<!--T:13-->
Structure

<!--T:14-->
* {{PropertyData|Landings}}: The type of landings.
* {{PropertyData|Stringer Offset}}: The offset between the border of the stairs and the structure.
* {{PropertyData|Stringer Width}}: The width of the stringers.
* {{PropertyData|Structure}}: The type of structure of these stairs.
* {{PropertyData|Structure Thickness}}: The thickness of the structure.
* {{PropertyData|Winders}}: The type of winders.

==Limitations== <!--T:5-->
* 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-->
{{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>
{{Code|code=
Stairs = makeStairs(baseobj=None, length=None, width=None, height=None, steps=None, name="Stairs")
}}
<translate>

<!--T:17-->
* Creates a {{incode|Stairs}} object from the given {{incode|baseobj}}.
* 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:
</translate>
{{Code|code=
import Arch

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

<!--T:22-->
{{Docnav
|[[Arch_Space|Space]]
|[[Arch_CompPanel|CompPanel]]
|[[Arch_Module|Arch]]
|IconL=Arch_Space.svg
|IconR=Arch_CompPanel.png
|IconC=Workbench_Arch.svg
}}

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

Revision as of 14:22, 29 November 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)