Arch Stairs: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
Line 37: Line 37:


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


==Usage== <!--T:2-->
==Usage== <!--T:2-->
Line 48: Line 48:
Segment and Parts
Segment and Parts


* {{PropertyData|AbsTop}}: (Output value only : ) The 'absolute' top level of a flight of stairs leads to. {{Version|0.18}}
* {{PropertyData|AbsTop}}: (read-only) The 'absolute' top level of a flight of stairs leads to. {{Version|0.18}}
* {{PropertyData|Last Segment}}: Last segment (flight or landing) of Arch Stairs connecting to this segment. The stairs will start from the level of the last segment. {{Version|0.18}}
* {{PropertyData|Last Segment}}: Last segment (flight or landing) of Arch Stairs connecting to this segment. The stairs will start from the level of the last segment. {{Version|0.18}}


<!--T:3-->
<!--T:3-->
Line 60: Line 60:
* {{PropertyData|Length}}: The total length of these stairs if no baseline is defined.
* {{PropertyData|Length}}: The total length of these stairs if no baseline is defined.
* {{PropertyData|Width}}: The width of these stairs.
* {{PropertyData|Width}}: The width of these stairs.
* {{PropertyData|Width of Landing}}: When Number of Steps = 1, the Stairs object act as a Landing. And when the baseline is multi-segment, the width of each segment of the Landing follow the list set here (for 2nd edge and after - 1st edge follows Width property). {{Version|0.18}}
* {{PropertyData|Width of Landing}}: When Number of Steps = 1, the Stairs object act as a Landing. And when the baseline is multi-segment, the width of each segment of the Landing follow the list set here (for 2nd edge and after - 1st edge follows Width property). {{Version|0.18}}


<!--T:11-->
<!--T:11-->
Line 66: Line 66:


<!--T:12-->
<!--T:12-->
* {{PropertyData|Blondel Ratio}}: (Output value only : ) The Blondel ratio indicates comfortable stairs and should be between 62 and 64cm or 24.5 and 25.5in.
* {{PropertyData|Blondel Ratio}}: (read-only) The Blondel ratio indicates comfortable stairs and should be between 62 and 64cm or 24.5 and 25.5in.
* {{PropertyData|Landing Depth}}: The depth of the landing of the flight, if enabled in Landings. Default to Width of stairs if 0. {{Version|0.18}}
* {{PropertyData|Landing Depth}}: The depth of the landing of the flight, if enabled in Landings. Default to Width of stairs if 0. {{Version|0.18}}
* {{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.
* {{PropertyData|Riser Height}}: (Output value only : ) The height of the risers - Height of stairs / Number of Steps or Riser Height Enforce.
* {{PropertyData|Riser Height}}: (read-only) The height of the risers - Height of stairs / Number of Steps or Riser Height Enforce.
* {{PropertyData|Riser Height Enforce}}: The height of the risers to enforce (override overall Height of stairs). {{Version|0.18}}
* {{PropertyData|Riser Height Enforce}}: The height of the risers to enforce (override overall Height of stairs). {{Version|0.18}}
* {{PropertyData|Riser Thickness}}: The thickness of the risers. {{Version|0.18}}
* {{PropertyData|Riser Thickness}}: The thickness of the risers. {{Version|0.18}}
* {{PropertyData|Tread Depth}}: (Output value only : ) The depth of the treads - Length of stairs / Number of Steps or Tread Depth Enforce.
* {{PropertyData|Tread Depth}}: (read-only) The depth of the treads - Length of stairs / Number of Steps or Tread Depth Enforce.
* {{PropertyData|Tread Depth Enforce}}: The depth of the treads to enforce (override overall Length of stairs). {{Version|0.18}}
* {{PropertyData|Tread Depth Enforce}}: The depth of the treads to enforce (override overall Length of stairs). {{Version|0.18}}
* {{PropertyData|Tread Thickness}}: The thickness of the treads.
* {{PropertyData|Tread Thickness}}: The thickness of the treads.
Line 81: Line 81:


<!--T:14-->
<!--T:14-->
* {{PropertyData|Flight}}: The direction of flight after landing. Can be Straight","HalfTurnLeft",or "HalfTurnRight". {{Version|0.18}}
* {{PropertyData|Flight}}: The direction of flight after landing. Can be Straight","HalfTurnLeft",or "HalfTurnRight". {{Version|0.18}}
* {{PropertyData|Landings}}: The type of landings. Can be "None" or "At center" ("At each corner" not implemented yet).
* {{PropertyData|Landings}}: The type of landings. Can be "None" or "At center" ("At each corner" not implemented yet).
* {{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.
* {{PropertyData|Stringer Width}}: The width of the stringers.
* {{PropertyData|Stringer Width}}: The width of the stringers.
* {{PropertyData|Structure}}: The type of structure of these stairs. Can be "None","Massive","One stringer",or "Two stringers".
* {{PropertyData|Structure}}: The type of structure of these stairs. Can be "None","Massive","One stringer",or "Two stringers".
* {{PropertyData|Structure Thickness}}: The thickness of the structure.
* {{PropertyData|Structure Thickness}}: The thickness of the structure.
* {{PropertyData|Winders}}: The type of winders (not implemented).
* {{PropertyData|Winders}}: The type of winders (not implemented).


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

Revision as of 20:16, 1 February 2022

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

Segment and Parts

  • DataAbsTop: (read-only) The 'absolute' top level of a flight of stairs leads to. introduced in version 0.18
  • DataLast Segment: Last segment (flight or landing) of Arch Stairs connecting to this segment. The stairs will start from the level of the last segment. introduced in version 0.18

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.
  • DataWidth of Landing: When Number of Steps = 1, the Stairs object act as a Landing. And when the baseline is multi-segment, the width of each segment of the Landing follow the list set here (for 2nd edge and after - 1st edge follows Width property). introduced in version 0.18

Steps

  • DataBlondel Ratio: (read-only) The Blondel ratio indicates comfortable stairs and should be between 62 and 64cm or 24.5 and 25.5in.
  • DataLanding Depth: The depth of the landing of the flight, if enabled in Landings. Default to Width of stairs if 0. introduced in version 0.18
  • DataNosing: The size of the nosing.
  • DataNumber of Steps: The numbers of steps (risers) in these stairs.
  • DataRiser Height: (read-only) The height of the risers - Height of stairs / Number of Steps or Riser Height Enforce.
  • DataRiser Height Enforce: The height of the risers to enforce (override overall Height of stairs). introduced in version 0.18
  • DataRiser Thickness: The thickness of the risers. introduced in version 0.18
  • DataTread Depth: (read-only) The depth of the treads - Length of stairs / Number of Steps or Tread Depth Enforce.
  • DataTread Depth Enforce: The depth of the treads to enforce (override overall Length of stairs). introduced in version 0.18
  • DataTread Thickness: The thickness of the treads.

Structure

  • DataFlight: The direction of flight after landing. Can be Straight","HalfTurnLeft",or "HalfTurnRight". introduced in version 0.18
  • DataLandings: The type of landings. Can be "None" or "At center" ("At each corner" not implemented yet).
  • 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. Can be "None","Massive","One stringer",or "Two stringers".
  • DataStructure Thickness: The thickness of the structure.
  • DataWinders: 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)