Arch Stairs: Difference between revisions

From FreeCAD Documentation
m (minor)
(Marked this version for translation)
 
(90 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>

{{GuiCommand|Name=Arch_Stairs|Workbenches=[[Arch Module|Arch]]|MenuLocation=Arch → Stairs|Shortcut=S R}}
==Description== <!--T:1-->
<!--T:23-->
{{Docnav
.
|[[Arch_Space|Space]]
|[[Arch_CompPanel|CompPanel]]
|[[Arch_Workbench|Arch]]
|IconL=Arch_Space.svg
|IconR=Arch_CompPanel.png
|IconC=Workbench_Arch.svg
}}

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

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

<!--T:1-->
The [[Arch_Stairs|Arch Stairs]] tool allows you to build several types of stairs automatically. Straight stairs (with or without a central landing) can be created from scratch. More complex stairs require base objects.

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

</translate>
</translate>
[[Image:Arch_Stairs_example.jpg|600px]]
[[File:Stairs_it.png|left]]
{{clear}}
<translate>
<translate>
==How to use== <!--T:2-->
<!--T:7-->
{{Caption|Two constructed stairs, one with a massive structure and a landing, the other with a single stringer.}}
Press the {{KEY|[[Image:Arch_Stairs.png|32px]] Stairs}} button, or press {{KEY|S}}, {{KEY|R}} keys

{{clear}}
==Options== <!--T:20-->
==Properties==

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

==Usage== <!--T:27-->

<!--T:2-->
# Optionally select one or more base objects, for example [[Draft_Line|Draft Lines]] and [[Draft_Wire|Draft Wires]]:
#* Draft Wires with two or more segments will be used to create landings. They must be on a plane parallel to the global XY plane. For example, select a U-shaped wire for a half-turn landing and an L-shaped wire for a corner landing.
#* Draft Lines will be used to create flights.
#* If the vertices of all lines and wires have correct Z coordinates, the created stairs will use this information.
#* The base objects must be selected in the correct order starting with the bottom object.
# Press the {{Button|[[Image:Arch_Stairs.svg|16px]] [[Arch_Stairs|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.

</translate>
</translate>
[[File:StairsProperties_it.png|left]]
[[Image:Arch_Stairs_Complex_Example.png|600px]]
<translate>
<translate>
===Data=== <!--T:3-->
<!--T:34-->
{{Caption|Complex stairs based on a selection of lines and wired as shown on the left.<br>
====Arch====
In red the wires used for the landings at Z&equals;1500mm, Z&equals;3000mm and Z&equals;4500mm.<br>
* {{PropertyData|Align}}: the lignment of these stairs on their baseline, if applicable
In black the lines connecting them used for the flights.
* {{PropertyData|Base}}: Edit (not yet implemented)
}}
* {{PropertyData|Height}}: the total height of these stairs
* {{PropertyData|Length}}: the total length of these stairs if no baseline is defined
* {{PropertyData|Width}}: the width of these stairs
====Base====
* {{PropertyData|Label}}: user name of the object (UTF8)
* {{PropertyData|Placement}}:
====Steps====
* {{PropertyData|Noising}}: the size of the noising
* {{PropertyData|Number of risers}}: numbers od 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
====Structure====
* {{PropertyData|Landigs}}: the type of landings
* {{PropertyData|Stringer Offset}}: the offset between the border of the stairs and the stringers
* {{PropertyData|Stringer Width}}: the width of the stringers
* {{PropertyData|Structure}}: the type of structure of these stairs
* {{PropertyData|Structure...}}: the thickness of the massive structure or of the stringers
* {{PropertyData|Winders}}: the type of winders


<!--T:4-->
==Properties== <!--T:6-->
{{clear}}


==Limitation== <!--T:5-->
===Data=== <!--T:28-->

See [http://forum.freecadweb.org/viewtopic.php?f=9&t=4564 Arch Stairs].
<!--T:29-->
{{TitleProperty|Segment and Parts}}

<!--T:30-->
* {{PropertyData|Abs Top|Vector}}: (read-only) The absolute top level the stairs lead to.
* {{PropertyData|Last Segment|Link}}: Last segment (flight or landing) of an Arch Stairs connecting to this segment. The start level of the stairs will be the end level of this last segment.
* {{PropertyData|Outline Left|VectorList}}: The left outline of the stairs.
* {{PropertyData|Outline Left All|VectorList}}: The left outline of all segments of the stairs.
* {{PropertyData|Outline Right|VectorList}}: The right outline of the stairs.
* {{PropertyData|Outline Right All|VectorList}}: The right outline of all segments of the stairs.
* {{PropertyData|Railing Height Left|Length}}: Height of the left railing of the stairs or landing.
* {{PropertyData|Railing Height Right|Length}}: Height of the right railing of the stairs or landing.
* {{PropertyData|Railing Left|LinkHidden}}: The left railing object. {{Version|0.20}}: Property type updated from {{Incode|String}} to {{Incode|LinkHidden}}.
* {{PropertyData|Railing Offset Left|Length}}: Offset of the left railing from the edge of the stairs or landing.
* {{PropertyData|Railing Offset Right|Length}}: Offset of the right railing from the edge of the stairs or landing.
* {{PropertyData|Railing Right|LinkHidden}}: The right railing object. {{Version|0.20}}: Property type updated from {{Incode|String}} to {{Incode|LinkHidden}}.

<!--T:31-->
{{TitleProperty|Stairs}}

<!--T:10-->
* {{PropertyData|Align|Enumeration}}: The alignment of the stairs on the baseline. Only used if a baseline is defined. Can be {{value|Left}}, {{value|Right}} or {{value|Center}}.
* {{PropertyData|Height|Length}}: The total height of the stairs. Only used if no baseline is defined, or if the baseline is horizontal. Ignored if {{PropertyData|Riser Height Enforce}} is non-zero.
* {{PropertyData|Length|Length}}: The total length of the stairs if no baseline is defined. Ignored if {{PropertyData|Tread Depth Enforce}} is non-zero.
* {{PropertyData|Width|Length}}: The width of the stairs.
* {{PropertyData|Width of Landing|FloatList}}: If the {{PropertyData|Number Of Steps}} is 1, the stairs object acts as a landing. When this is the case and the baseline is multi-segment, the width of first segment of the landing follows the {{PropertyData|Width}}, the widths of subsequent segments follow the list set here.

<!--T:11-->
{{TitleProperty|Steps}}

<!--T:12-->
* {{PropertyData|Blondel Ratio|Float}}: (read-only) The calculated Blondel ratio. This ratio indicates comfortable stairs and should be between 62 and 64cm or 24.5 and 25.5in.
* {{PropertyData|Landing Depth|Length}}: The depth of the landing of the flight, if enabled in {{PropertyData|Landings}}. Defaults to the {{PropertyData|Width}} if 0.
* {{PropertyData|Nosing|Length}}: The size of the nosing.
* {{PropertyData|Number Of Steps|Integer}}: The numbers of steps (risers). Must be at least 2 for a single flight, and at least 4 for a stairs with a central landing.
* {{PropertyData|Riser Height|Length}}: (read-only) The height of the risers. If {{PropertyData|Riser Height Enforce}} is 0 it is calculated ({{PropertyData|Height}} / {{PropertyData|Number of Steps}}). Else it is the same as {{PropertyData|Riser Height Enforce}}.
* {{PropertyData|Riser Height Enforce|Length}}: The enforced height of the risers.
* {{PropertyData|Riser Thickness|Length}}: The thickness of the risers.
* {{PropertyData|Tread Depth|Length}}: (read-only) The depth of the treads. If {{PropertyData|Tread Depth Enforce}} is 0 it is calculated ({{PropertyData|Length}} / {{PropertyData|Number of Steps}}). Else it is the same as {{PropertyData|Tread Depth Enforce}}.
* {{PropertyData|Tread Depth Enforce|Length}}: The enforced depth of the treads.
* {{PropertyData|Tread Thickness|Length}}: The thickness of the treads.

<!--T:13-->
{{TitleProperty|Structure}}

<!--T:14-->
* {{PropertyData|Connection Down Start Stairs|Enumeration}}: The type of connection between the lower floor slab and the start of the stairs. Can be {{value|HorizontalCut}}, {{value|VerticalCut}} or {{value|HorizontalVerticalCut}}.
* {{PropertyData|Connection End Stairs Up|Enumeration}}: The type of connection between the end of the stairs and the upper floor slab. Can be {{value|toFlightThickness}} or {{value|toSlabThickness}}.
* {{PropertyData|Down Slab Thickness|Length}}: The thickness of the lower floor slab.
* {{PropertyData|Flight|Enumeration}}: The direction of the flight after the landing. Can be {{value|Straight}}, {{value|HalfTurnLeft}} or {{value|HalfTurnRight}}.
* {{PropertyData|Landings|Enumeration}}: The type of landings. Can be {{value|None}} or {{value|At center}} ({{value|At each corner}} not implemented yet).
* {{PropertyData|Stringer Overlap|Length}}: The overlap of the stringers above the bottom of the treads.
* {{PropertyData|Stringer Width|Length}}: The width of the stringers.
* {{PropertyData|Structure|Enumeration}}: The structure type of the stairs. Can be {{value|None}}, {{value|Massive}}, {{value|One stringer}} or {{value|Two stringers}}.
* {{PropertyData|Structure Offset|Length}}: The offset between the border of the stairs and the structure.
* {{PropertyData|Structure Thickness|Length}}: The thickness of the structure.
* {{PropertyData|Up Slab Thickness|Length}}: The thickness of the upper floor slab.
* {{PropertyData|Winders|Enumeration}}: The type of winders. Not implemented.

==Limitations== <!--T:32-->

<!--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:33-->

<!--T:15-->
{{Emphasis|See also:}} [[Arch_API|Arch API]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].

<!--T:16-->
The Stairs tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following function:
</translate>
</translate>
{{Code|code=
<languages/>
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_Workbench|Arch]]
|IconL=Arch_Space.svg
|IconR=Arch_CompPanel.png
|IconC=Workbench_Arch.svg
}}

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

Latest revision as of 17:49, 23 February 2023

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 several types of stairs automatically. Straight stairs (with or without a central landing) can be created from scratch. More complex stairs require base objects.

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, the other with a single stringer.

Options

Usage

  1. Optionally select one or more base objects, for example Draft Lines and Draft Wires:
    • Draft Wires with two or more segments will be used to create landings. They must be on a plane parallel to the global XY plane. For example, select a U-shaped wire for a half-turn landing and an L-shaped wire for a corner landing.
    • Draft Lines will be used to create flights.
    • If the vertices of all lines and wires have correct Z coordinates, the created stairs will use this information.
    • The base objects must be selected in the correct order starting with the bottom object.
  2. Press the Arch Stairs button, or press S, R keys.
  3. 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.

Complex stairs based on a selection of lines and wired as shown on the left.
In red the wires used for the landings at Z=1500mm, Z=3000mm and Z=4500mm.
In black the lines connecting them used for the flights.

Properties

Data

Segment and Parts

  • DataAbs Top (Vector): (read-only) The absolute top level the stairs lead to.
  • DataLast Segment (Link): Last segment (flight or landing) of an Arch Stairs connecting to this segment. The start level of the stairs will be the end level of this last segment.
  • DataOutline Left (VectorList): The left outline of the stairs.
  • DataOutline Left All (VectorList): The left outline of all segments of the stairs.
  • DataOutline Right (VectorList): The right outline of the stairs.
  • DataOutline Right All (VectorList): The right outline of all segments of the stairs.
  • DataRailing Height Left (Length): Height of the left railing of the stairs or landing.
  • DataRailing Height Right (Length): Height of the right railing of the stairs or landing.
  • DataRailing Left (LinkHidden): The left railing object. introduced in version 0.20: Property type updated from String to LinkHidden.
  • DataRailing Offset Left (Length): Offset of the left railing from the edge of the stairs or landing.
  • DataRailing Offset Right (Length): Offset of the right railing from the edge of the stairs or landing.
  • DataRailing Right (LinkHidden): The right railing object. introduced in version 0.20: Property type updated from String to LinkHidden.

Stairs

  • DataAlign (Enumeration): The alignment of the stairs on the baseline. Only used if a baseline is defined. Can be Left, Right or Center.
  • DataHeight (Length): The total height of the stairs. Only used if no baseline is defined, or if the baseline is horizontal. Ignored if DataRiser Height Enforce is non-zero.
  • DataLength (Length): The total length of the stairs if no baseline is defined. Ignored if DataTread Depth Enforce is non-zero.
  • DataWidth (Length): The width of the stairs.
  • DataWidth of Landing (FloatList): If the DataNumber Of Steps is 1, the stairs object acts as a landing. When this is the case and the baseline is multi-segment, the width of first segment of the landing follows the DataWidth, the widths of subsequent segments follow the list set here.

Steps

  • DataBlondel Ratio (Float): (read-only) The calculated Blondel ratio. This ratio indicates comfortable stairs and should be between 62 and 64cm or 24.5 and 25.5in.
  • DataLanding Depth (Length): The depth of the landing of the flight, if enabled in DataLandings. Defaults to the DataWidth if 0.
  • DataNosing (Length): The size of the nosing.
  • DataNumber Of Steps (Integer): The numbers of steps (risers). Must be at least 2 for a single flight, and at least 4 for a stairs with a central landing.
  • DataRiser Height (Length): (read-only) The height of the risers. If DataRiser Height Enforce is 0 it is calculated (DataHeight / DataNumber of Steps). Else it is the same as DataRiser Height Enforce.
  • DataRiser Height Enforce (Length): The enforced height of the risers.
  • DataRiser Thickness (Length): The thickness of the risers.
  • DataTread Depth (Length): (read-only) The depth of the treads. If DataTread Depth Enforce is 0 it is calculated (DataLength / DataNumber of Steps). Else it is the same as DataTread Depth Enforce.
  • DataTread Depth Enforce (Length): The enforced depth of the treads.
  • DataTread Thickness (Length): The thickness of the treads.

Structure

  • DataConnection Down Start Stairs (Enumeration): The type of connection between the lower floor slab and the start of the stairs. Can be HorizontalCut, VerticalCut or HorizontalVerticalCut.
  • DataConnection End Stairs Up (Enumeration): The type of connection between the end of the stairs and the upper floor slab. Can be toFlightThickness or toSlabThickness.
  • DataDown Slab Thickness (Length): The thickness of the lower floor slab.
  • DataFlight (Enumeration): The direction of the flight after the landing. Can be Straight, HalfTurnLeft or HalfTurnRight.
  • DataLandings (Enumeration): The type of landings. Can be None or At center (At each corner not implemented yet).
  • DataStringer Overlap (Length): The overlap of the stringers above the bottom of the treads.
  • DataStringer Width (Length): The width of the stringers.
  • DataStructure (Enumeration): The structure type of the stairs. Can be None, Massive, One stringer or Two stringers.
  • DataStructure Offset (Length): The offset between the border of the stairs and the structure.
  • DataStructure Thickness (Length): The thickness of the structure.
  • DataUp Slab Thickness (Length): The thickness of the upper floor slab.
  • DataWinders (Enumeration): The type of winders. Not implemented.

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)