formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Helix
Description
Creates a wire helix around a wire path.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_helix_around_wire(
fzrt_int | windex, |
path_obj, | |
model_type, | |
double | n_cycles, |
double | radius, |
helx_opts, | |
refn_opts, | |
obj ) |
Parameters
windex [Input]
project window index
path_obj [Input]
path object. Must be an open or closed wire or a surface object with a single face and single curve.
model_type [Input]
model type
n_cycles [Input]
number of cycles
Range: n_cycles > 0.0
radius [Input]
helix radius
Range: radius > 0.0
helx_opts [Input, Optional]
construction options. For defaults see fz_objt_helix_parm_enum
refn_opts [Input, Optional]
display resolution options. For defaults see fz_attr_refn_parm_enum
obj [Result]
new object
Returns
Error codes
Availability
5.0.0.0
Example Files
See Also
Function Set
Defined in