Arch Stairs/en: Difference between revisions

From FreeCAD Documentation
(Neue Version von externer Quelle importiert)
(Updating to match new version of source page)
Line 2: Line 2:
==Description==
==Description==
The stair tool to build and define a staircase of any type
The stair tool to build and define a staircase of any type

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.

[[Image:Arch Stairs example.jpg|640px]]


[[File:Stairs_it.png|left]]
[[File:Stairs_it.png|left]]
Line 30: Line 34:
* {{PropertyData|Tread Thickness}}: the thickness of the treads
* {{PropertyData|Tread Thickness}}: the thickness of the treads


* {{PropertyData|Align}}: The alignment of these stairs on their baseline, if applicable.
====Structure====
* {{PropertyData|Landigs}}: the type of landings
* {{PropertyData|Base}}: The baseline of these stairs, if any.
* {{PropertyData|Stringer Offset}}: the offset between the border of the stairs and the stringers
* {{PropertyData|Height}}: The total height of these stairs, if not based on a baseline, or the baseline is horizontal.
* {{PropertyData|Stringer Width}}: the width of the stringers
* {{PropertyData|Length}}: The total length of these stairs if no baseline is defined.
* {{PropertyData|Structure}}: the type of structure of these stairs
* {{PropertyData|Width}}: The width of these stairs.
* {{PropertyData|Structure...}}: the thickness of the massive structure or of the stringers
* {{PropertyData|Winders}}: the type of winders


Steps
{{clear}}

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

Structure

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

== Scripting ==

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

<syntaxhighlight>
makeStairs([base], [length], [width], [height], [steps])
</syntaxhighlight>

* Creates a stairs object with the given attributes.
* Returns the new stairs object.

Example:

<syntaxhighlight>
import Arch
makeStairs(length=5, width=1.2, height=3, steps=14)
</syntaxhighlight>


==Limitation==
==Limitation==
See [http://forum.freecadweb.org/viewtopic.php?f=9&t=4564 Arch Stairs].
See [http://forum.freecadweb.org/viewtopic.php?f=9&t=4564 Arch Stairs].

{{clear}}

<languages/>
<languages/>

Revision as of 13:20, 23 February 2014

Arch_Stairs

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

Description

The stair tool to build and define a staircase of any type

See the Stairs entry in wikipedia for a definition of the different terms used to describe parts of stairs.

File:Stairs it.png

How to use

Press the Stairs button, or press S, R keys

Properties

Data

Arch

  • DataAlign: the lignment of these stairs on their baseline, if applicable
  • DataBase: Edit (not yet implemented)
  • DataHeight: the total height of these stairs
  • DataLength: the total length of these stairs if no baseline is defined
  • DataWidth: the width of these stairs

Base

  • DataLabel: user name of the object (UTF8)
  • DataPlacement:

Steps

  • DataNosing: the size of the nosing
  • DataNumber of risers: numbers od 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
  • 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)

Limitation

See Arch Stairs.