Arch Stairs: Difference between revisions

From FreeCAD Documentation
No edit summary
(Completing the Properties...)
Line 53: Line 53:
{{TitleProperty|Segment and Parts}}
{{TitleProperty|Segment and Parts}}


* {{PropertyData|Abs Top|Vector}}: (read-only) The 'absolute' top level of a flight of stairs leads to.
* {{PropertyData|Abs Top|Vector}}: (read-only) The absolute top level the stairs lead to.
* {{PropertyData|Last Segment|Link}}: Last segment (flight or landing) of Arch Stairs connecting to this segment. The stairs start level will start from the end level of the last segment.
* {{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}}
* {{PropertyData|Outline Left|VectorList}}: The left outline of the stairs.
* {{PropertyData|Outline Left All|VectorList}}
* {{PropertyData|Outline Left All|VectorList}}: The left outline of all segments of the stairs.
* {{PropertyData|Outline Right|VectorList}}
* {{PropertyData|Outline Right|VectorList}}: The right outline of the stairs.
* {{PropertyData|Outline Right All|VectorList}}
* {{PropertyData|Outline Right All|VectorList}}: The right outline of all segments of the stairs.
* {{PropertyData|Railing Height Left|Length}}
* {{PropertyData|Railing Height Left|Length}}: Height of the left railing of the stairs or landing.
* {{PropertyData|Railing Height Right|Length}}
* {{PropertyData|Railing Height Right|Length}}: Height of the right railing of the stairs or landing.
* {{PropertyData|Railing Left|String}}
* {{PropertyData|Railing Left|String}}: Name of the left railing object.
* {{PropertyData|Railing Offset Left|Length}}
* {{PropertyData|Railing Offset Left|Length}}: Offset of the left railing from the edge of the stairs or landing.
* {{PropertyData|Railing Offset Right|Length}}
* {{PropertyData|Railing Offset Right|Length}}: Offset of the right railing from the edge of the stairs or landing.
* {{PropertyData|Railing Right|String}}
* {{PropertyData|Railing Right|String}}: Name of the right railing object.


{{TitleProperty|Stairs}}
{{TitleProperty|Stairs}}

Revision as of 09:26, 9 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

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 (String): Name of the left railing object.
  • 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 (String): Name of the right railing object.

Stairs

  • DataAlign (Enumeration): The alignment of these stairs on their baseline, if applicable.
  • DataHeight (Length): The total height of these stairs, if not based on a baseline, or the baseline is horizontal.
  • DataLength (Length): The total length of these stairs if no baseline is defined.
  • DataWidth (Length): The width of these stairs.
  • DataWidth of Landing (FloatList): 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).

Steps

  • DataBlondel Ratio (Float): (read-only) The Blondel 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 Landings. Default to Width of stairs if 0.
  • DataNosing (Length): The size of the nosing.
  • DataNumber Of Steps (Integer): The numbers of steps (risers) in these stairs.
  • DataRiser Height (Length): (read-only) The height of the risers - Height of stairs / Number of Steps or Riser Height Enforce.
  • DataRiser Height Enforce (Length): The height of the risers to enforce (override overall Height of stairs).
  • DataRiser Thickness (Length): The thickness of the risers.
  • DataTread Depth (Length): (read-only) The depth of the treads - Length of stairs / Number of Steps or Tread Depth Enforce.
  • DataTread Depth Enforce (Length): The depth of the treads to enforce (override overall Length of stairs).
  • DataTread Thickness (Length): The thickness of the treads.

Structure

  • DataConnection Down Start Stairs (Enumeration)
  • DataConnection End Stairs Up (Enumeration)
  • DataDown Slab Thickness (Length)
  • DataFlight (Enumeration): The direction of flight after 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)
  • DataStringer Width (Length): The width of the stringers.
  • DataStructure (Enumeration): The type of structure of these 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)
  • 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)