formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Spiral Stair

# fz_objt_cnstr_spirstair

Description

Creates a spiral stair object.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_spirstair(

fzrt_int | windex,
fz_xyz_td * | ax_p1,
fz_xyz_td * | ax_p2,
fz_xyz_td * | ax_p3,
double | inside_radius,
double | outside_radius,
double | stair_height,
fz_objt_spirstair_cnstr_opts_ptr | spir_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

ax_p1 [Input]

axis 1

ax_p2 [Input]

axis 2

ax_p3 [Input]

axis 3

inside_radius [Input]

inside radius

Range: inside_radius > 0.0

outside_radius [Input]

outside radius

Range: outside_radius > inside_radius

stair_height [Input]

height if stairs

Range: stair_height > inside_radius

spir_opts [Input, Optional]

construction options. For defaults see fz_objt_spirstair_parm_enum.

obj [Result]

spiral stair object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_cnstr_sstr.fsl

See Also

fz_objt_cnstr_spirstair_opts_init, fz_objt_cnstr_spirstair_opts_finit,,

Function Set

fz_model_fset

Defined in

fz_objt_stair_api.h