formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Control Objects | Helix
Description
Creates a wire helix around an axis.
Plugin Prototype
fzrt_error_td fz_objt_cnstr_helix_around_axis(
fzrt_int | windex, |
model_type, | |
ax_p1, | |
ax_p2, | |
ax_ref, | |
double | n_cycles, |
double | length, |
double | radius, |
helx_opts, | |
refn_opts, | |
obj ) |
Parameters
windex [Input]
project window index
model_type [Input]
model type
ax_p1 [Input]
first point on helix axis
ax_p2 [Input]
second point on helix axis
ax_ref [Input]
third point. Must be off the axis defined by ax_p1 and ax_p2. This point determines where the helix starts.
n_cycles [Input]
number of cycles.
Range: n_cycles > 0.0
length [Input]
helix length
Range: length > 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