MAXScript Language Reference > 3ds Max Objects > Node : MAXWrapper > Node Subclasses > GeometryClass : Node > Geometry - Stairs >

# Spiral_Stair : GeometryClass

    Spiral_Stair - superclass: GeometryClass; super-superclass:node -40:1- classID: #(1486695442, 1030831817)

Value > MAXWrapper > Node > GeometryClass > Spiral_Stair

| Geometry Objects - Quick Navigation

This class is available in 3ds Max 6 and higher.

Constructor:

    Spiral_Stair...

Properties:

    <Spiral_Stair>.CarriageContext Integer default: 18 -- integer

Get/Set the carriage configuration control value. Some possible values are:

0 - First carriage at the inner side at user-defined internal offset, specified number of carriages repeat at user-defined spacing starting from it.

1 - First carriage at inner side without offset, second carriage at outer side without offset, if CarriageCount is greater than 2, additional carriages spread evently between the two ignorring spacing settings.

2 - Variable number of carriages spread evenly based on the CarriageSpace value and CarriageSpacingType settings.

3 - First carriage at inner side without offset, user-defined number of carriages starting from the first one, placed at user-defined CarriageSpace respecting CarriageSpacingType settings.

4 - First carriage at inner side without offset but respecting CarriageSpacingType, second carriage at outer side respecting the CarriageExtOffs value. If CarriageCount is greater than 2, additional carriages spread evently between the two ignorring spacing settings.

5 - First carriage at outer side respecting CarriageExtOffs value, other carriages starting from it at CarriageSpace distance respecting CarriageSpacingType.

6 - First carriage at inner side respecting CarriageIntOffs value, other carriages starting from it respecting CarriageCount, CarriageSpace and CarriageSpacingType. Allows for carriages outside of the actual stair when using too high values.

7 - First carriage at inner side respecting CarriageIntOffs value, second carriage at outer side ignorring CarriageExtOffs value, other carriages based on CarriageCount value spead evenly between the two respecting CarriageSpacingType but ignorring CarriageSpace.

8, 9 - First carriage at inner side respecting CarriageIntOffs value, other carriages at CarriageSpace distance starting from it respecting CarriageSpacingType (axis to axis or side to side).

10 - First carriage at the inner side, second carriage at the outer side, third and more carriages spread relatively to the middle of the stair, ignorring CarriageSpacingType.

11 - First carriage at the inner side, second carriage at user-defined CarriageSpace distance from it respecting CarriageSpacingType (inner side to inner side or outer side to inner side).

12 - First carriage at the inner side, second carriage in the middle of the stair, more carriages spread relatively to the middle of the stair, respecting CarriageSpacingType.

13 - First carriage at the outer side, more carriages following at user-defined CarriageSpace distance, only appear when inside the stair area, respect CarriageSpacingType (outer side to outer side or inner side to outer side).

14,16,17 - First carriage at inner side respecting CarriageIntOffs value, other carriages at CarriageSpace distance starting from it respecting CarriageSpacingType (axis to axis or side to side).

15 - First carriage at inner side respecting CarriageIntOffs value. When two or more carriages, first at the outer side, second at the middle. When three or more, first at outer side, other carriages spread evenly around the middle of the stair ignorring CarriageSpace, respecting CarriageSpacingType.

18 - First carriage in the middle of the stair, when more than one, spread symmetrically to the middle of the stair, respecting CarriageSpacingType.

    <Spiral_Stair>.CarriageCount Integer default: 1 -- animatable; integer

Get/Set the number of carriages. Usage depends on the current CarriageContext value.

    <Spiral_Stair>.CarriageExtOffs Float default: 3.0 -- animatable; float

Get/Set the carriage's external offset. Usage depends on the current CarriageContext value.

    <Spiral_Stair>.CarriageHeight Float default: 8.0 -- animatable; float

Get/Set the carriage height. Corresponds to the "Depth" value in the "Carriage" rollout.

    <Spiral_Stair>.CarriageIntOffs Float default: 3.0 -- animatable; float

Get/Set the carriage's internal offset. Usage depends on the current CarriageContext value.

    <Spiral_Stair>.CarriageSpace Float default: 10.0 -- animatable; float

Get/Set the spacing between carriages. Usage depends on the current CarriageContext value.

    <Spiral_Stair>.CarriageSpacingType Integer default: 0 -- integer

Get/Set the carriage spacing type. Possible values are 0 and 1 and effect vary depending on the . CarriageContext value.

    <Spiral_Stair>.CarriageSpringFloor Integer default: 1 -- animatable; integer

Controls the state of the "Spring from Floor" checkbox in the "Carriage" rollout. Possible values are

0 - off

1 - on

    <Spiral_Stair>.CarriageWidth Float default: 3.0 -- animatable; float

Get/Set the carriage width.

    <Spiral_Stair>.CenterPoleHeight Float default: 0.0 -- animatable; float

Get/Set the center pole height.

    <Spiral_Stair>.CenterPoleHeight_X Integer default: 0 -- integer

Enable / Disable the usage of the CenterPoleheight value. Possible values are

0 - don't use CenterPoleHeight

1 - use CenterPoleHeight

    <Spiral_Stair>.CenterPoleRadius Float default: 10.0 -- animatable; float

Get/Set the center pole radius.

    <Spiral_Stair>.CenterPoleSegments Integer default: 16 -- animatable; integer

Get/Set the number of center pole segments..

    <Spiral_Stair>.direction Integer default: 0 -- animatable; integer

Get/Set the rotation direction. Possible values are

0 - CCW

1 - CW

    <Spiral_Stair>.GenerateCarriage Integer default: 1 -- animatable; integer

Controls the state of the "Carriage" checkbox in the "Parameters" rollout, "Generate Geometry" group. Possible values are

0 - don't generate Carriage

1 - generate Carriage

    <Spiral_Stair>.GenerateCenterPole Integer default: 0 -- animatable; integer

Controls the state of the "Center Pole" checkbox in the "Parameters" rollout, "Generate Geometry" group. Possible values are

0 - don't generate Center Pole

1 - generate Center Pole

    <Spiral_Stair>.GenerateInsideRailing Integer default: 0 -- integer

Controls the state of the "Handrail - Inside" checkbox in the "Parameters" rollout, "Generate Geometry" group. Possible values are

0 - don't generate Inside Railing

1 - generate Inside Railing

    <Spiral_Stair>.GenerateMapping Integer default: 0 -- integer

Controls the state of the "Generate maping Coords." checkbox in the "Parameters" rollout. Possible values are

0 - off

1 - on

    <Spiral_Stair>.GenerateOutsideRailing Integer default: 0 -- integer

Controls the state of the "Handrail - Outside" checkbox in the "Parameters" rollout, "Generate Geometry" group. Possible values are

0 - don't generate Outside Railing

1 - generate Outside Railing

    <Spiral_Stair>.GenerateStringers Integer default: 0 -- animatable; integer

Controls the state of the "Stringers" checkbox in the "Parameters" rollout, "Generate Geometry" group. Possible values are

0 - don't generate Stringers

1 - generate Stringers

    <Spiral_Stair>.radius Float default: 0.0 -- animatable; float

Get/Set the radius of the stair.

    <Spiral_Stair>.RailingHeight Float default: 42.0 -- animatable; float

Get/Set the height of the railing.

    <Spiral_Stair>.RailingOffs Float default: 2.0 -- animatable; float

Get/Set the offset of the railing.

    <Spiral_Stair>.RailingRadius Float default: 1.0 -- animatable; float

Get/Set the radius of the railing.

    <Spiral_Stair>.RailingSegments Integer default: 3 -- animatable; integer

Get/Set the number of segments of the railing.

    <Spiral_Stair>.Revolutions Float default: 0.75 -- animatable; float

Get/Set the number of revolutions

    <Spiral_Stair>.StepCount Integer default: 12 -- animatable; integer

Get/Set the number of steps.

    <Spiral_Stair>.StepDepth Float default: 0.0 -- animatable; float

Get/Set the depth of the steps when StepDepth_X is set to 1.

    <Spiral_Stair>.StepDepth_X Integer default: 0 -- integer

Enable/Disable the use of the custom StepDepth value. Possible values are:

0 - off

1 - on

    <Spiral_Stair>.StepHeight Float default: 0.0 -- animatable; float

Get/Set the height of the steps.

    <Spiral_Stair>.StepSegments Integer default: 0 -- animatable; integer

Get/Set the number of step segments.

    <Spiral_Stair>.StepSegments_X Integer default: 0 -- integer

Enable/Disable the use of the StepSegments value. Possible values are:

0 - off

1 - on

    <Spiral_Stair>.StepThickness Float default: 2.0 -- animatable; float

Get/Set the thickness of the steps.

    <Spiral_Stair>.StepType Integer default: 0 -- integer

Get/Set the step type. Possible values are

0 - Open

1 - Closed

2 - Box

    <Spiral_Stair>.Stepwidth Float default: 39.0 -- animatable; float

Get/Set the width of the steps.

    <Spiral_Stair>.StringerDepth Float default: 6.0 -- animatable; float

Get/Set the depth of the stringer.

    <Spiral_Stair>.StringerOffset Float default: 1.0 -- animatable; float

Get/Set the offset of the stringer.

    <Spiral_Stair>.StringerSpringFloor Integer default: 1 -- animatable; integer

Controls the state of the "Spring from Floor" checkbox in the "Stringers" rollout. Possible values are

0 - off

1 - on

    <Spiral_Stair>.StringerWidth Float default: 1.0 -- animatable; float

Get/Set the width of the stringer.

Interfaces:

    Interface: realWorldMapSizeInterface

Properties:

    .realWorldMapSize: boolean : Read|Write

Enables/disables the real-world map size option.

Available in 3ds Max 8 and higher.

#### See Also

- Geometry - Stairs

- GeometryClass Common Properties, Operators, and Methods

- Node Common Properties, Operators, and Methods

- MAXWrapper Common Properties, Operators, and Methods

- Value Common Properties, Operators, and Methods