formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Stair From Path

# fz_objt_cnstr_pathstair

Description

Creates a straight stair object from a wire path.

Plugin Prototype

fzrt_error_td fz_objt_cnstr_pathstair(

fzrt_int | windex,
fz_objt_ptr | pth_obj,
fz_objt_pathstair_type_enum | type,
double | width,
double | height,
fz_objt_pathstair_cnstr_opts_ptr | sstr_opts,
fz_objt_ptr * | obj )

Parameters

windex [Input]

project window index

pth_obj [Input]

path object

type [Input]

parameter id

width [Input]

stair width

Range: width > 0.0

height [Input]

stair height

Range: height > 0.0

sstr_opts [Input, Optional]

construction options. For defaults see fz_objt_pathstair_parm_enum.

obj [Result]

stair object

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_cnstr_sstr.fsl

See Also

fz_objt_cnstr_pathstair_opts_init,, fz_objt_cnstr_pathstair_opts_get,

Function Set

fz_model_fset

Defined in

fz_objt_stair_api.h