Arch Stairs: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
Line 4: Line 4:
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 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 17: Line 18:
# 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 30:
* {{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 40:
* {{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 51:
* {{PropertyData|Winders}}: The type of winders.
* {{PropertyData|Winders}}: The type of winders.


== Scripting ==
== Scripting == <!--T:15-->


<!--T:16-->
Stairs can be created from python scripts and [[macros]] by using the following function:
Stairs can be created from python scripts and [[macros]] by using the following function:


Line 55: Line 62:
<translate>
<translate>


<!--T:17-->
* Creates a stairs object with the given attributes.
* Creates a stairs object with the given attributes.
* Returns the new stairs object.
* Returns the new stairs object.


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



Revision as of 13:19, 23 February 2014

Arch Stairs

Menu location
Arch → Stairs
Workbenches
Arch
Default shortcut
S R
Introduced in version
-
See also
None

Description

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 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.

On the above image, two stairs were created, one with a massive structure and a landing, and another one with a single stringer.

How to use

  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.

Scripting

Stairs can be created from python scripts and macros by using the following function:

 makeStairs([base], [length], [width], [height], [steps])
  • Creates a stairs object with the given attributes.
  • Returns the new stairs object.

Example:

 import Arch
 makeStairs(length=5, width=1.2, height=3, steps=14)

Limitations

  • Not available before FreeCAD version 0.14
  • Only straight stairs are available at the moment
  • See the forum announcement.